Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


XercesNotationBridge.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(XERCESNOTATIONBRIDGE_HEADER_GUARD_1357924680)
19 #define XERCESNOTATIONBRIDGE_HEADER_GUARD_1357924680
20 
21 
22 
24 
25 
26 
27 #if XERCES_VERSION_MAJOR >= 2
28 #include <xercesc/dom/deprecated/DOM_Notation.hpp>
29 #else
30 #include <xercesc/dom/DOM_Notation.hpp>
31 #endif
32 
33 
34 
36 
37 
38 
40 
41 
42 
43 XALAN_CPP_NAMESPACE_BEGIN
44 
45 
46 
48 
49 
50 /**
51  * This class is deprecated.
52  *
53  * @deprecated This class is part of the deprecated Xerces DOM bridge.
54  */
56 {
57 public:
58 
60  const DOM_NotationType& theXercesDOMNotation,
61  const XercesBridgeNavigator& theNavigator);
62 
63  virtual
65 
66 
67  // These interfaces are inherited from XalanNode...
68 
69  virtual const XalanDOMString&
70  getNodeName() const;
71 
72  /**
73  * Gets the value of this node, depending on its type.
74  */
75  virtual const XalanDOMString&
76  getNodeValue() const;
77 
78  /**
79  * An enum value representing the type of the underlying object.
80  */
81  virtual NodeType
82  getNodeType() const;
83 
84  /**
85  * Gets the parent of this node.
86  *
87  * All nodes, except <code>Document</code>,
88  * <code>DocumentFragment</code>, and <code>Attr</code> may have a parent.
89  * However, if a node has just been created and not yet added to the tree,
90  * or if it has been removed from the tree, a <code>null</code> DOM_Node
91  * is returned.
92  */
93  virtual XalanNode*
94  getParentNode() const;
95 
96  /**
97  * Gets a <code>NodeList</code> that contains all children of this node.
98  *
99  * If there
100  * are no children, this is a <code>NodeList</code> containing no nodes.
101  * The content of the returned <code>NodeList</code> is "live" in the sense
102  * that, for instance, changes to the children of the node object that
103  * it was created from are immediately reflected in the nodes returned by
104  * the <code>NodeList</code> accessors; it is not a static snapshot of the
105  * content of the node. This is true for every <code>NodeList</code>,
106  * including the ones returned by the <code>getElementsByTagName</code>
107  * method.
108  */
109  virtual const XalanNodeList*
110  getChildNodes() const;
111 
112  /**
113  * Gets the first child of this node.
114  *
115  * If there is no such node, this returns <code>null</code>.
116  */
117  virtual XalanNode*
118  getFirstChild() const;
119 
120  /**
121  * Gets the last child of this node.
122  *
123  * If there is no such node, this returns <code>null</code>.
124  */
125  virtual XalanNode*
126  getLastChild() const;
127 
128  /**
129  * Gets the node immediately preceding this node.
130  *
131  * If there is no such node, this returns <code>null</code>.
132  */
133  virtual XalanNode*
134  getPreviousSibling() const;
135 
136  /**
137  * Gets the node immediately following this node.
138  *
139  * If there is no such node, this returns <code>null</code>.
140  */
141  virtual XalanNode*
142  getNextSibling() const;
143 
144  /**
145  * Gets a <code>NamedNodeMap</code> containing the attributes of this node (if it
146  * is an <code>Element</code>) or <code>null</code> otherwise.
147  */
148  virtual const XalanNamedNodeMap*
149  getAttributes() const;
150 
151  /**
152  * Gets the <code>DOM_Document</code> object associated with this node.
153  *
154  * This is also
155  * the <code>DOM_Document</code> object used to create new nodes. When this
156  * node is a <code>DOM_Document</code> or a <code>DOM_DocumentType</code>
157  * which is not used with any <code>DOM_Document</code> yet, this is
158  * <code>null</code>.
159  */
160  virtual XalanDocument*
161  getOwnerDocument() const;
162 
163  //@}
164  /** @name Cloning function. */
165  //@{
166 
167  /**
168  * Returns a duplicate of this node.
169  *
170  * This function serves as a generic copy constructor for nodes.
171  *
172  * The duplicate node has no parent (
173  * <code>parentNode</code> returns <code>null</code>.).
174  * <br>Cloning an <code>Element</code> copies all attributes and their
175  * values, including those generated by the XML processor to represent
176  * defaulted attributes, but this method does not copy any text it contains
177  * unless it is a deep clone, since the text is contained in a child
178  * <code>Text</code> node. Cloning any other type of node simply returns a
179  * copy of this node.
180  * @param deep If <code>true</code>, recursively clone the subtree under the
181  * specified node; if <code>false</code>, clone only the node itself (and
182  * its attributes, if it is an <code>Element</code>).
183  * @return The duplicate node.
184  */
185 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
186  virtual XalanNode*
187 #else
188  virtual XercesNotationBridge*
189 #endif
190  cloneNode(bool deep) const;
191 
192  //@}
193  /** @name Functions to modify the DOM Node. */
194  //@{
195 
196  /**
197  * Inserts the node <code>newChild</code> before the existing child node
198  * <code>refChild</code>.
199  *
200  * If <code>refChild</code> is <code>null</code>,
201  * insert <code>newChild</code> at the end of the list of children.
202  * <br>If <code>newChild</code> is a <code>DocumentFragment</code> object,
203  * all of its children are inserted, in the same order, before
204  * <code>refChild</code>. If the <code>newChild</code> is already in the
205  * tree, it is first removed. Note that a <code>DOM_Node</code> that
206  * has never been assigned to refer to an actual node is == null.
207  * @param newChild The node to insert.
208  * @param refChild The reference node, i.e., the node before which the new
209  * node must be inserted.
210  * @return The node being inserted.
211  */
212  virtual XalanNode*
213  insertBefore(
214  XalanNode* newChild,
215  XalanNode* refChild);
216 
217  /**
218  * Replaces the child node <code>oldChild</code> with <code>newChild</code>
219  * in the list of children, and returns the <code>oldChild</code> node.
220  *
221  * If <CODE>newChild</CODE> is a <CODE>DOM_DocumentFragment</CODE> object,
222  * <CODE>oldChild</CODE> is replaced by all of the <CODE>DOM_DocumentFragment</CODE>
223  * children, which are inserted in the same order.
224  *
225  * If the <code>newChild</code> is already in the tree, it is first removed.
226  * @param newChild The new node to put in the child list.
227  * @param oldChild The node being replaced in the list.
228  * @return The node replaced.
229  */
230  virtual XalanNode*
231  replaceChild(
232  XalanNode* newChild,
233  XalanNode* oldChild);
234 
235  /**
236  * Removes the child node indicated by <code>oldChild</code> from the list
237  * of children, and returns it.
238  *
239  * @param oldChild The node being removed.
240  * @return The node removed.
241  */
242  virtual XalanNode*
243  removeChild(XalanNode* oldChild);
244 
245  /**
246  * Adds the node <code>newChild</code> to the end of the list of children of
247  * this node.
248  *
249  * If the <code>newChild</code> is already in the tree, it is
250  * first removed.
251  * @param newChild The node to add.If it is a <code>DocumentFragment</code>
252  * object, the entire contents of the document fragment are moved into
253  * the child list of this node
254  * @return The node added.
255  */
256  virtual XalanNode*
257  appendChild(XalanNode* newChild);
258 
259  //@}
260  /** @name Query functions. */
261  //@{
262 
263  /**
264  * This is a convenience method to allow easy determination of whether a
265  * node has any children.
266  *
267  * @return <code>true</code> if the node has any children,
268  * <code>false</code> if the node has no children.
269  */
270  virtual bool
271  hasChildNodes() const;
272 
273 
274  //@}
275  /** @name Set functions. */
276  //@{
277 
278 
279  /**
280  * Sets the value of the node.
281  *
282  * Any node which can have a nodeValue (@see getNodeValue) will
283  * also accept requests to set it to a string. The exact response to
284  * this varies from node to node -- Attribute, for example, stores
285  * its values in its children and has to replace them with a new Text
286  * holding the replacement value.
287  *
288  * For most types of Node, value is null and attempting to set it
289  * will throw DOMException(NO_MODIFICATION_ALLOWED_ERR). This will
290  * also be thrown if the node is read-only.
291  */
292  virtual void
293  setNodeValue(const XalanDOMString& nodeValue);
294 
295  //@}
296  /** @name Functions introduced in DOM Level 2. */
297  //@{
298 
299  /**
300  * Puts all <CODE>DOM_Text</CODE>
301  * nodes in the full depth of the sub-tree underneath this <CODE>DOM_Node</CODE>,
302  * including attribute nodes, into a "normal" form where only markup (e.g.,
303  * tags, comments, processing instructions, CDATA sections, and entity
304  * references) separates <CODE>DOM_Text</CODE>
305  * nodes, i.e., there are no adjacent <CODE>DOM_Text</CODE>
306  * nodes. This can be used to ensure that the DOM view of a document is the
307  * same as if it were saved and re-loaded, and is useful when operations
308  * (such as XPointer lookups) that depend on a particular document tree
309  * structure are to be used.
310  * <P><B>Note:</B> In cases where the document contains <CODE>DOM_CDATASections</CODE>,
311  * the normalize operation alone may not be sufficient, since XPointers do
312  * not differentiate between <CODE>DOM_Text</CODE>
313  * nodes and <CODE>DOM_CDATASection</CODE> nodes.</P>
314  */
315  virtual void
316  normalize();
317 
318  /**
319  * Tests whether the DOM implementation implements a specific
320  * feature and that feature is supported by this node.
321  * @param feature The string of the feature to test. This is the same
322  * name as what can be passed to the method <code>hasFeature</code> on
323  * <code>DOMImplementation</code>.
324  * @param version This is the version number of the feature to test. In
325  * Level 2, version 1, this is the string "2.0". If the version is not
326  * specified, supporting any version of the feature will cause the
327  * method to return <code>true</code>.
328  * @return Returns <code>true</code> if the specified feature is supported
329  * on this node, <code>false</code> otherwise.
330  */
331  virtual bool
332  isSupported(
333  const XalanDOMString& feature,
334  const XalanDOMString& version) const;
335 
336  /**
337  * Get the <em>namespace URI</em> of
338  * this node, or <code>null</code> if it is unspecified.
339  * <p>
340  * This is not a computed value that is the result of a namespace lookup
341  * based on an examination of the namespace declarations in scope. It is
342  * merely the namespace URI given at creation time.
343  * <p>
344  * For nodes of any type other than <CODE>ELEMENT_NODE</CODE> and
345  * <CODE>ATTRIBUTE_NODE</CODE> and nodes created with a DOM Level 1 method,
346  * such as <CODE>createElement</CODE> from the <CODE>Document</CODE>
347  * interface, this is always <CODE>null</CODE>.
348  */
349  virtual const XalanDOMString&
350  getNamespaceURI() const;
351 
352  /**
353  * Get the <em>namespace prefix</em>
354  * of this node, or <code>null</code> if it is unspecified.
355  */
356  virtual const XalanDOMString&
357  getPrefix() const;
358 
359  /**
360  * Returns the local part of the <em>qualified name</em> of this node.
361  * <p>
362  * For nodes created with a DOM Level 1 method, such as
363  * <code>createElement</code> from the <code>DOM_Document</code> interface,
364  * it is null.
365  */
366  virtual const XalanDOMString&
367  getLocalName() const;
368 
369  /**
370  * Set the <em>namespace prefix</em> of this node.
371  * <p>
372  * Note that setting this attribute, when permitted, changes
373  * the <CODE>nodeName</CODE> attribute, which holds the <EM>qualified
374  * name</EM>, as well as the <CODE>tagName</CODE> and <CODE>name</CODE>
375  * attributes of the <CODE>DOM_Element</CODE> and <CODE>DOM_Attr</CODE>
376  * interfaces, when applicable.
377  * <p>
378  * Note also that changing the prefix of an
379  * attribute, that is known to have a default value, does not make a new
380  * attribute with the default value and the original prefix appear, since the
381  * <CODE>namespaceURI</CODE> and <CODE>localName</CODE> do not change.
382  *
383  * @param prefix The prefix of this node.
384  * @exception DOMException
385  * INVALID_CHARACTER_ERR: Raised if the specified prefix contains
386  * an illegal character.
387  * <br>
388  * NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
389  * <br>
390  * NAMESPACE_ERR: Raised if the specified <CODE>prefix</CODE> is
391  * malformed, if the specified prefix is "xml" and the
392  * <CODE>namespaceURI</CODE> of this node is different from
393  * "http://www.w3.org/XML/1998/namespace", if specified prefix is
394  * "xmlns" and the <CODE>namespaceURI</CODE> is neither
395  * <CODE>null</CODE> nor an empty string, or if the
396  * <CODE>localName</CODE> is <CODE>null</CODE>.
397  */
398  virtual void
399  setPrefix(const XalanDOMString& prefix);
400 
401  virtual bool
402  isIndexed() const;
403 
404  virtual IndexType
405  getIndex() const;
406 
407  //@}
408 
409  // These interfaces are inherited from XalanNotation...
410 
411  /**
412  * Get the public identifier of this notation.
413  *
414  * If the public identifier was not
415  * specified, this is <code>null</code>.
416  * @return Returns the public identifier of the notation
417  */
418  virtual const XalanDOMString&
419  getPublicId() const;
420 
421  /**
422  * Get the system identifier of this notation.
423  *
424  * If the system identifier was not
425  * specified, this is <code>null</code>.
426  * @return Returns the system identifier of the notation
427  */
428  virtual const XalanDOMString&
429  getSystemId() const;
430 
431  /**
432  * Get the Xerces node this instance represent.
433  *
434  * @return The Xerces node
435  */
438  {
439  return m_xercesNode;
440  }
441 
442 private:
443 
444  // Not implemented...
445  XercesNotationBridge(const XercesNotationBridge& theSource);
446 
448  operator=(const XercesNotationBridge& theSource);
449 
450  bool
451  operator==(const XercesNotationBridge& theRHS) const;
452 
453  // Data members...
454  DOM_NotationType m_xercesNode;
455 
456  const XercesBridgeNavigator& m_navigator;
457 };
458 
459 
460 
461 XALAN_CPP_NAMESPACE_END
462 
463 
464 
465 #endif // !defined(XERCESNOTATIONBRIDGE_HEADER_GUARD_1357924680)
virtual XalanNode * getLastChild() const =0
Gets the last child of this node.
virtual bool isIndexed() const =0
Determine if the document is node-order indexed.
DOM_NotationType getXercesNode() const
Get the Xerces node this instance represent.
XalanNotation & operator=(const XalanNotation &theSource)
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.
#define XALAN_XERCESPARSERLIAISON_EXPORT
virtual NodeType getNodeType() const =0
An enum value representing the type of the underlying object.
virtual IndexType getIndex() const =0
Get the node&#39;s index.
virtual XalanNode * getFirstChild() const =0
Gets the first child of this node.
XERCES_CPP_NAMESPACE_QUALIFIER DOM_Notation DOM_NotationType
virtual const XalanDOMString & getPublicId() const =0
Get the public identifier of this notation.
virtual XalanDocument * getOwnerDocument() const =0
Gets the Document object associated with this node.
virtual const XalanDOMString & getPrefix() const =0
Get the namespace prefix of this node, or null if it is unspecified.
virtual const XalanDOMString & getNamespaceURI() const =0
Get the namespace URI of this node, or null if it is unspecified.
bool operator==(const XalanNotation &theRHS) const
unsigned long IndexType
Definition: XalanNode.hpp:64
This class is deprecated.
virtual XalanNode * getPreviousSibling() const =0
Gets the node immediately preceding this node.
virtual const XalanDOMString & getLocalName() const =0
Returns the local part of the qualified name of this node.
This class is deprecated.
virtual XalanNode * getParentNode() const =0
Gets the parent of this node.
virtual XalanNode * getNextSibling() const =0
Gets the node immediately following this node.
virtual const XalanNamedNodeMap * getAttributes() const =0
Gets a NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise...
virtual const XalanDOMString & getNodeName() const =0
Gets the name of this node, depending on its type.
virtual const XalanDOMString & getSystemId() const =0
Get the system identifier of this notation.

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

Xalan-C++ XSLT Processor Version 1.11
Copyright © 1999-2012 The Apache Software Foundation.
All Rights Reserved.

Apache Logo