Xalan-C++ API Reference  1.12.0
XercesTextBridge.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(XERCESTEXTBRIDGE_HEADER_GUARD_1357924680)
19 #define XERCESTEXTBRIDGE_HEADER_GUARD_1357924680
20 
21 
22 
24 
25 
26 
27 #if XERCES_VERSION_MAJOR >= 2
28 #include <xercesc/dom/deprecated/DOM_Text.hpp>
29 #else
30 #include <xercesc/dom/DOM_Text.hpp>
31 #endif
32 
33 
35 
36 
37 
39 
40 
41 
42 namespace XALAN_CPP_NAMESPACE {
43 
44 
45 
46 class XercesBridgeNavigator;
47 
48 
49 /**
50  * This class is deprecated.
51  *
52  * @deprecated This class is part of the deprecated Xerces DOM bridge.
53  */
55 {
56 public:
57 
58  typedef xercesc::DOM_Text DOM_TextType;
59 
61  const DOM_TextType& theXercesText,
62  const XercesBridgeNavigator& theNavigator);
63 
64  virtual
66 
67 
68  /**
69  * Gets the name of this node.
70  */
71  virtual const XalanDOMString&
72  getNodeName() const;
73 
74  /**
75  * Gets the value of this node, depending on its type.
76  */
77  virtual const XalanDOMString&
78  getNodeValue() const;
79 
80  /**
81  * An enum value representing the type of the underlying object.
82  */
83  virtual NodeType
84  getNodeType() const;
85 
86  /**
87  * Gets the parent of this node.
88  *
89  * All nodes, except <code>Document</code>,
90  * <code>DocumentFragment</code>, and <code>Attr</code> may have a parent.
91  * However, if a node has just been created and not yet added to the tree,
92  * or if it has been removed from the tree, a <code>null</code> DOM_Node
93  * is returned.
94  */
95  virtual XalanNode*
96  getParentNode() const;
97 
98  /**
99  * Gets a <code>NodeList</code> that contains all children of this node.
100  *
101  * If there
102  * are no children, this is a <code>NodeList</code> containing no nodes.
103  * The content of the returned <code>NodeList</code> is "live" in the sense
104  * that, for instance, changes to the children of the node object that
105  * it was created from are immediately reflected in the nodes returned by
106  * the <code>NodeList</code> accessors; it is not a static snapshot of the
107  * content of the node. This is true for every <code>NodeList</code>,
108  * including the ones returned by the <code>getElementsByTagName</code>
109  * method.
110  */
111  virtual const XalanNodeList*
112  getChildNodes() const;
113 
114  /**
115  * Gets the first child of this node.
116  *
117  * If there is no such node, this returns <code>null</code>.
118  */
119  virtual XalanNode*
120  getFirstChild() const;
121 
122  /**
123  * Gets the last child of this node.
124  *
125  * If there is no such node, this returns <code>null</code>.
126  */
127  virtual XalanNode*
128  getLastChild() const;
129 
130  /**
131  * Gets the node immediately preceding this node.
132  *
133  * If there is no such node, this returns <code>null</code>.
134  */
135  virtual XalanNode*
136  getPreviousSibling() const;
137 
138  /**
139  * Gets the node immediately following this node.
140  *
141  * If there is no such node, this returns <code>null</code>.
142  */
143  virtual XalanNode*
144  getNextSibling() const;
145 
146  /**
147  * Gets a <code>NamedNodeMap</code> containing the attributes of this node (if it
148  * is an <code>Element</code>) or <code>null</code> otherwise.
149  */
150  virtual const XalanNamedNodeMap*
151  getAttributes() const;
152 
153  /**
154  * Gets the <code>DOM_Document</code> object associated with this node.
155  *
156  * This is also
157  * the <code>DOM_Document</code> object used to create new nodes. When this
158  * node is a <code>DOM_Document</code> or a <code>DOM_DocumentType</code>
159  * which is not used with any <code>DOM_Document</code> yet, this is
160  * <code>null</code>.
161  */
162  virtual XalanDocument*
163  getOwnerDocument() const;
164 
165  //@}
166  /** @name Cloning function. */
167  //@{
168 
169  /**
170  * Returns a duplicate of this node.
171  *
172  * This function serves as a generic copy constructor for nodes.
173  *
174  * The duplicate node has no parent (
175  * <code>parentNode</code> returns <code>null</code>.).
176  * <br>Cloning an <code>Element</code> copies all attributes and their
177  * values, including those generated by the XML processor to represent
178  * defaulted attributes, but this method does not copy any text it contains
179  * unless it is a deep clone, since the text is contained in a child
180  * <code>Text</code> node. Cloning any other type of node simply returns a
181  * copy of this node.
182  * @param deep If <code>true</code>, recursively clone the subtree under the
183  * specified node; if <code>false</code>, clone only the node itself (and
184  * its attributes, if it is an <code>Element</code>).
185  * @return The duplicate node.
186  */
187  virtual XercesTextBridge*
188  cloneNode(bool deep) const;
189 
190  //@}
191  /** @name Functions to modify the DOM Node. */
192  //@{
193 
194  /**
195  * Inserts the node <code>newChild</code> before the existing child node
196  * <code>refChild</code>.
197  *
198  * If <code>refChild</code> is <code>null</code>,
199  * insert <code>newChild</code> at the end of the list of children.
200  * <br>If <code>newChild</code> is a <code>DocumentFragment</code> object,
201  * all of its children are inserted, in the same order, before
202  * <code>refChild</code>. If the <code>newChild</code> is already in the
203  * tree, it is first removed. Note that a <code>DOM_Node</code> that
204  * has never been assigned to refer to an actual node is == null.
205  * @param newChild The node to insert.
206  * @param refChild The reference node, i.e., the node before which the new
207  * node must be inserted.
208  * @return The node being inserted.
209  */
210  virtual XalanNode*
211  insertBefore(
212  XalanNode* newChild,
213  XalanNode* refChild);
214 
215  /**
216  * Replaces the child node <code>oldChild</code> with <code>newChild</code>
217  * in the list of children, and returns the <code>oldChild</code> node.
218  *
219  * If <CODE>newChild</CODE> is a <CODE>DOM_DocumentFragment</CODE> object,
220  * <CODE>oldChild</CODE> is replaced by all of the <CODE>DOM_DocumentFragment</CODE>
221  * children, which are inserted in the same order.
222  *
223  * If the <code>newChild</code> is already in the tree, it is first removed.
224  * @param newChild The new node to put in the child list.
225  * @param oldChild The node being replaced in the list.
226  * @return The node replaced.
227  */
228  virtual XalanNode*
229  replaceChild(
230  XalanNode* newChild,
231  XalanNode* oldChild);
232 
233  /**
234  * Removes the child node indicated by <code>oldChild</code> from the list
235  * of children, and returns it.
236  *
237  * @param oldChild The node being removed.
238  * @return The node removed.
239  */
240  virtual XalanNode*
241  removeChild(XalanNode* oldChild);
242 
243  /**
244  * Adds the node <code>newChild</code> to the end of the list of children of
245  * this node.
246  *
247  * If the <code>newChild</code> is already in the tree, it is
248  * first removed.
249  * @param newChild The node to add.If it is a <code>DocumentFragment</code>
250  * object, the entire contents of the document fragment are moved into
251  * the child list of this node
252  * @return The node added.
253  */
254  virtual XalanNode*
255  appendChild(XalanNode* newChild);
256 
257  //@}
258  /** @name Query functions. */
259  //@{
260 
261  /**
262  * This is a convenience method to allow easy determination of whether a
263  * node has any children.
264  *
265  * @return <code>true</code> if the node has any children,
266  * <code>false</code> if the node has no children.
267  */
268  virtual bool
269  hasChildNodes() const;
270 
271 
272  //@}
273  /** @name Set functions. */
274  //@{
275 
276 
277  /**
278  * Sets the value of the node.
279  *
280  * Any node which can have a nodeValue (@see getNodeValue) will
281  * also accept requests to set it to a string. The exact response to
282  * this varies from node to node -- Attribute, for example, stores
283  * its values in its children and has to replace them with a new Text
284  * holding the replacement value.
285  *
286  * For most types of Node, value is null and attempting to set it
287  * will throw DOMException(NO_MODIFICATION_ALLOWED_ERR). This will
288  * also be thrown if the node is read-only.
289  */
290  virtual void
291  setNodeValue(const XalanDOMString& nodeValue);
292 
293  //@}
294  /** @name Functions introduced in DOM Level 2. */
295  //@{
296 
297  /**
298  * Puts all <CODE>DOM_Text</CODE>
299  * nodes in the full depth of the sub-tree underneath this <CODE>DOM_Node</CODE>,
300  * including attribute nodes, into a "normal" form where only markup (e.g.,
301  * tags, comments, processing instructions, CDATA sections, and entity
302  * references) separates <CODE>DOM_Text</CODE>
303  * nodes, i.e., there are no adjacent <CODE>DOM_Text</CODE>
304  * nodes. This can be used to ensure that the DOM view of a document is the
305  * same as if it were saved and re-loaded, and is useful when operations
306  * (such as XPointer lookups) that depend on a particular document tree
307  * structure are to be used.
308  * <P><B>Note:</B> In cases where the document contains <CODE>DOM_CDATASections</CODE>,
309  * the normalize operation alone may not be sufficient, since XPointers do
310  * not differentiate between <CODE>DOM_Text</CODE>
311  * nodes and <CODE>DOM_CDATASection</CODE> nodes.</P>
312  */
313  virtual void
314  normalize();
315 
316  /**
317  * Tests whether the DOM implementation implements a specific
318  * feature and that feature is supported by this node.
319  * @param feature The string of the feature to test. This is the same
320  * name as what can be passed to the method <code>hasFeature</code> on
321  * <code>DOMImplementation</code>.
322  * @param version This is the version number of the feature to test. In
323  * Level 2, version 1, this is the string "2.0". If the version is not
324  * specified, supporting any version of the feature will cause the
325  * method to return <code>true</code>.
326  * @return Returns <code>true</code> if the specified feature is supported
327  * on this node, <code>false</code> otherwise.
328  */
329  virtual bool
330  isSupported(
331  const XalanDOMString& feature,
332  const XalanDOMString& version) const;
333 
334  /**
335  * Get the <em>namespace URI</em> of
336  * this node, or <code>null</code> if it is unspecified.
337  * <p>
338  * This is not a computed value that is the result of a namespace lookup
339  * based on an examination of the namespace declarations in scope. It is
340  * merely the namespace URI given at creation time.
341  * <p>
342  * For nodes of any type other than <CODE>ELEMENT_NODE</CODE> and
343  * <CODE>ATTRIBUTE_NODE</CODE> and nodes created with a DOM Level 1 method,
344  * such as <CODE>createElement</CODE> from the <CODE>Document</CODE>
345  * interface, this is always <CODE>null</CODE>.
346  */
347  virtual const XalanDOMString&
348  getNamespaceURI() const;
349 
350  /**
351  * Get the <em>namespace prefix</em>
352  * of this node, or <code>null</code> if it is unspecified.
353  */
354  virtual const XalanDOMString&
355  getPrefix() const;
356 
357  /**
358  * Returns the local part of the <em>qualified name</em> of this node.
359  * <p>
360  * For nodes created with a DOM Level 1 method, such as
361  * <code>createElement</code> from the <code>DOM_Document</code> interface,
362  * it is null.
363  */
364  virtual const XalanDOMString&
365  getLocalName() const;
366 
367  /**
368  * Set the <em>namespace prefix</em> of this node.
369  * <p>
370  * Note that setting this attribute, when permitted, changes
371  * the <CODE>nodeName</CODE> attribute, which holds the <EM>qualified
372  * name</EM>, as well as the <CODE>tagName</CODE> and <CODE>name</CODE>
373  * attributes of the <CODE>DOM_Element</CODE> and <CODE>DOM_Attr</CODE>
374  * interfaces, when applicable.
375  * <p>
376  * Note also that changing the prefix of an
377  * attribute, that is known to have a default value, does not make a new
378  * attribute with the default value and the original prefix appear, since the
379  * <CODE>namespaceURI</CODE> and <CODE>localName</CODE> do not change.
380  *
381  * @param prefix The prefix of this node.
382  * @exception DOMException
383  * INVALID_CHARACTER_ERR: Raised if the specified prefix contains
384  * an illegal character.
385  * <br>
386  * NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
387  * <br>
388  * NAMESPACE_ERR: Raised if the specified <CODE>prefix</CODE> is
389  * malformed, if the specified prefix is "xml" and the
390  * <CODE>namespaceURI</CODE> of this node is different from
391  * "http://www.w3.org/XML/1998/namespace", if specified prefix is
392  * "xmlns" and the <CODE>namespaceURI</CODE> is neither
393  * <CODE>null</CODE> nor an empty string, or if the
394  * <CODE>localName</CODE> is <CODE>null</CODE>.
395  */
396  virtual void
397  setPrefix(const XalanDOMString& prefix);
398 
399  virtual bool
400  isIndexed() const;
401 
402  virtual IndexType
403  getIndex() const;
404 
405  //@}
406 
407  // These interfaces are inherited from XalanText...
408 
409  /** @name Getter functions. */
410  //@{
411  /**
412  * Returns the character data of the node that implements this interface.
413  *
414  * The DOM implementation may not put arbitrary limits on the amount of data that
415  * may be stored in a <code>CharacterData</code> node. However,
416  * implementation limits may mean that the entirety of a node's data may
417  * not fit into a single <code>DOMString</code>. In such cases, the user
418  * may call <code>substringData</code> to retrieve the data in
419  * appropriately sized pieces.
420  * @exception DOMException
421  * NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly.
422  * @exception DOMException
423  * DOMSTRING_SIZE_ERR: Raised when it would return more characters than
424  * fit in a <code>DOMString</code> variable on the implementation
425  * platform.
426  */
427  virtual const XalanDOMString&
428  getData() const;
429 
430  /**
431  * Returns the number of characters that are available through <code>data</code> and
432  * the <code>substringData</code> method below.
433  *
434  * This may have the value
435  * zero, i.e., <code>CharacterData</code> nodes may be empty.
436  */
437  virtual unsigned int
438  getLength() const;
439 
440  /**
441  * Extracts a range of data from the node.
442  *
443  * @param offset Start offset of substring to extract.
444  * @param count The number of characters to extract.
445  * @return The specified substring. If the sum of <code>offset</code> and
446  * <code>count</code> exceeds the <code>length</code>, then all
447  * characters to the end of the data are returned.
448  * @exception DOMException
449  * INDEX_SIZE_ERR: Raised if the specified offset is negative or greater
450  * than the number of characters in <code>data</code>, or if the
451  * specified <code>count</code> is negative.
452  * <br>DOMSTRING_SIZE_ERR: Raised if the specified range of text does not
453  * fit into a <code>DOMString</code>.
454  */
455  virtual XalanDOMString
456  substringData(
457  unsigned int offset,
458  unsigned int count) const;
459 
460  //@}
461  /** @name Functions that set or change data. */
462  //@{
463  /**
464  * Append the string to the end of the character data of the node.
465  *
466  * Upon success, <code>data</code> provides access to the concatenation of
467  * <code>data</code> and the <code>DOMString</code> specified.
468  * @param arg The <code>DOMString</code> to append.
469  * @exception DOMException
470  * NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
471  */
472  virtual void
473  appendData(const XalanDOMString& arg);
474 
475  /**
476  * Insert a string at the specified character offset.
477  *
478  * @param offset The character offset at which to insert.
479  * @param arg The <code>DOMString</code> to insert.
480  * @exception DOMException
481  * INDEX_SIZE_ERR: Raised if the specified offset is negative or greater
482  * than the number of characters in <code>data</code>.
483  * <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
484  */
485  virtual void
486  insertData(
487  unsigned int offset,
488  const XalanDOMString& arg);
489 
490  /**
491  * Remove a range of characters from the node.
492  *
493  * Upon success,
494  * <code>data</code> and <code>length</code> reflect the change.
495  * @param offset The offset from which to remove characters.
496  * @param count The number of characters to delete. If the sum of
497  * <code>offset</code> and <code>count</code> exceeds <code>length</code>
498  * then all characters from <code>offset</code> to the end of the data
499  * are deleted.
500  * @exception DOMException
501  * INDEX_SIZE_ERR: Raised if the specified offset is negative or greater
502  * than the number of characters in <code>data</code>, or if the
503  * specified <code>count</code> is negative.
504  * <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
505  */
506  virtual void
507  deleteData(
508  unsigned int offset,
509  unsigned int count);
510 
511  /**
512  * Replace the characters starting at the specified character offset with
513  * the specified string.
514  *
515  * @param offset The offset from which to start replacing.
516  * @param count The number of characters to replace. If the sum of
517  * <code>offset</code> and <code>count</code> exceeds <code>length</code>
518  * , then all characters to the end of the data are replaced (i.e., the
519  * effect is the same as a <code>remove</code> method call with the same
520  * range, followed by an <code>append</code> method invocation).
521  * @param arg The <code>DOMString</code> with which the range must be
522  * replaced.
523  * @exception DOMException
524  * INDEX_SIZE_ERR: Raised if the specified offset is negative or greater
525  * than the number of characters in <code>data</code>, or if the
526  * specified <code>count</code> is negative.
527  * <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
528  */
529  virtual void
530  replaceData(
531  unsigned int offset,
532  unsigned int count,
533  const XalanDOMString& arg);
534 
535  //@}
536 
537  //@}
538  /** @name Functions to modify the Text node. */
539  //@{
540 
541  /**
542  * Breaks this node into two nodes at the specified
543  * offset, keeping both in the tree as siblings.
544  *
545  * This node then only
546  * contains all the content up to the <code>offset</code> point. And a new
547  * node of the same nodeType, which is inserted as the next sibling of this
548  * node, contains all the content at and after the <code>offset</code>
549  * point. When the <code>offset</code> is equal to the lenght of this node,
550  * the new node has no data.
551  * @param offset The offset at which to split, starting from 0.
552  * @return The new <code>Text</code> node.
553  * @exception DOMException
554  * INDEX_SIZE_ERR: Raised if the specified offset is negative or greater
555  * than the number of characters in <code>data</code>.
556  * <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
557  */
558  virtual XalanText*
559  splitText(unsigned int offset);
560 
561  //@}
562 
563  virtual bool
564  isWhitespace() const;
565 
566  /**
567  * Get the Xerces node this instance represent.
568  *
569  * @return The Xerces node
570  */
573  {
574  return m_xercesNode;
575  }
576 
577 private:
578 
579  // Not implemented...
580  XercesTextBridge(const XercesTextBridge& theSource);
581 
583  operator=(const XercesTextBridge& theSource);
584 
585  bool
586  operator==(const XercesTextBridge& theRHS) const;
587 
588  // Data members...
589  XercesDOM_TextHack m_xercesNode;
590 
591  const XercesBridgeNavigator& m_navigator;
592 };
593 
594 
595 
596 }
597 
598 
599 
600 #endif // !defined(XERCESTEXTBRIDGE_HEADER_GUARD_1357924680)
xalanc::XercesDOM_TextHack
Definition: XercesDOM_NodeHack.hpp:151
XALAN_CPP_NAMESPACE
#define XALAN_CPP_NAMESPACE
Xalan-C++ namespace, including major and minor version.
Definition: XalanVersion.hpp:76
XalanText.hpp
xalanc::XalanNode
Definition: XalanNode.hpp:38
xalanc::XercesTextBridge::getXercesNode
DOM_TextType getXercesNode() const
Get the Xerces node this instance represent.
Definition: XercesTextBridge.hpp:572
xalanc::XalanNode::NodeType
NodeType
Definition: XalanNode.hpp:47
xalanc::XalanText
Definition: XalanText.hpp:40
xalanc::XalanDocument
Definition: XalanDocument.hpp:36
xalanc::operator==
bool operator==(const XalanVector< Type > &theLHS, const XalanVector< Type > &theRHS)
Definition: XalanVector.hpp:1118
xalanc::XalanNode::IndexType
unsigned long IndexType
Definition: XalanNode.hpp:64
XercesParserLiaisonDefinitions.hpp
xalanc::XalanNodeList
Definition: XalanNodeList.hpp:36
xalanc::XercesTextBridge::DOM_TextType
xercesc::DOM_Text DOM_TextType
Definition: XercesTextBridge.hpp:58
xalanc::XercesTextBridge
This class is deprecated.
Definition: XercesTextBridge.hpp:54
XALAN_XERCESPARSERLIAISON_EXPORT
#define XALAN_XERCESPARSERLIAISON_EXPORT
Definition: XercesParserLiaisonDefinitions.hpp:39
XercesDOM_NodeHack.hpp
xalanc::XalanNamedNodeMap
Definition: XalanNamedNodeMap.hpp:36
xalanc::XercesBridgeNavigator
This class is deprecated.
Definition: XercesBridgeNavigator.hpp:55
xalanc::XalanDOMString
Definition: XalanDOMString.hpp:45