00001 /* 00002 * Licensed to the Apache Software Foundation (ASF) under one 00003 * or more contributor license agreements. See the NOTICE file 00004 * distributed with this work for additional information 00005 * regarding copyright ownership. The ASF licenses this file 00006 * to you under the Apache License, Version 2.0 (the "License"); 00007 * you may not use this file except in compliance with the License. 00008 * You may obtain a copy of the License at 00009 * 00010 * http://www.apache.org/licenses/LICENSE-2.0 00011 * 00012 * Unless required by applicable law or agreed to in writing, software 00013 * distributed under the License is distributed on an "AS IS" BASIS, 00014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 00015 * See the License for the specific language governing permissions and 00016 * limitations under the License. 00017 */ 00018 #if !defined(XERCESCOMMENTBRIDGE_HEADER_GUARD_1357924680) 00019 #define XERCESCOMMENTBRIDGE_HEADER_GUARD_1357924680 00020 00021 00022 00023 #include <xalanc/XercesParserLiaison/XercesParserLiaisonDefinitions.hpp> 00024 00025 00026 00027 #if XERCES_VERSION_MAJOR >= 2 00028 #include <xercesc/dom/deprecated/DOM_Comment.hpp> 00029 #else 00030 #include <xercesc/dom/DOM_Comment.hpp> 00031 #endif 00032 00033 00034 00035 #include <xalanc/XalanDOM/XalanComment.hpp> 00036 00037 00038 00039 #include <xalanc/XercesParserLiaison/Deprecated/XercesBridgeTypes.hpp> 00040 00041 00042 00043 XALAN_CPP_NAMESPACE_BEGIN 00044 00045 00046 00047 class XercesBridgeNavigator; 00048 00049 00050 /** 00051 * This class is deprecated. 00052 * 00053 * @deprecated This class is part of the deprecated Xerces DOM bridge. 00054 */ 00055 class XALAN_XERCESPARSERLIAISON_EXPORT XercesCommentBridge : public XalanComment 00056 { 00057 public: 00058 00059 XercesCommentBridge( 00060 const DOM_CommentType& theXercesComment, 00061 const XercesBridgeNavigator& theNavigator); 00062 00063 virtual 00064 ~XercesCommentBridge(); 00065 00066 00067 /** 00068 * Gets the name of this node. 00069 */ 00070 virtual const XalanDOMString& 00071 getNodeName() const; 00072 00073 /** 00074 * Gets the value of this node, depending on its type. 00075 */ 00076 virtual const XalanDOMString& 00077 getNodeValue() const; 00078 00079 /** 00080 * An enum value representing the type of the underlying object. 00081 */ 00082 virtual NodeType 00083 getNodeType() const; 00084 00085 /** 00086 * Gets the parent of this node. 00087 * 00088 * All nodes, except <code>Document</code>, 00089 * <code>DocumentFragment</code>, and <code>Attr</code> may have a parent. 00090 * However, if a node has just been created and not yet added to the tree, 00091 * or if it has been removed from the tree, a <code>null</code> DOM_Node 00092 * is returned. 00093 */ 00094 virtual XalanNode* 00095 getParentNode() const; 00096 00097 /** 00098 * Gets a <code>NodeList</code> that contains all children of this node. 00099 * 00100 * If there 00101 * are no children, this is a <code>NodeList</code> containing no nodes. 00102 * The content of the returned <code>NodeList</code> is "live" in the sense 00103 * that, for instance, changes to the children of the node object that 00104 * it was created from are immediately reflected in the nodes returned by 00105 * the <code>NodeList</code> accessors; it is not a static snapshot of the 00106 * content of the node. This is true for every <code>NodeList</code>, 00107 * including the ones returned by the <code>getElementsByTagName</code> 00108 * method. 00109 */ 00110 virtual const XalanNodeList* 00111 getChildNodes() const; 00112 00113 /** 00114 * Gets the first child of this node. 00115 * 00116 * If there is no such node, this returns <code>null</code>. 00117 */ 00118 virtual XalanNode* 00119 getFirstChild() const; 00120 00121 /** 00122 * Gets the last child of this node. 00123 * 00124 * If there is no such node, this returns <code>null</code>. 00125 */ 00126 virtual XalanNode* 00127 getLastChild() const; 00128 00129 /** 00130 * Gets the node immediately preceding this node. 00131 * 00132 * If there is no such node, this returns <code>null</code>. 00133 */ 00134 virtual XalanNode* 00135 getPreviousSibling() const; 00136 00137 /** 00138 * Gets the node immediately following this node. 00139 * 00140 * If there is no such node, this returns <code>null</code>. 00141 */ 00142 virtual XalanNode* 00143 getNextSibling() const; 00144 00145 /** 00146 * Gets a <code>NamedNodeMap</code> containing the attributes of this node (if it 00147 * is an <code>Element</code>) or <code>null</code> otherwise. 00148 */ 00149 virtual const XalanNamedNodeMap* 00150 getAttributes() const; 00151 00152 /** 00153 * Gets the <code>DOM_Document</code> object associated with this node. 00154 * 00155 * This is also 00156 * the <code>DOM_Document</code> object used to create new nodes. When this 00157 * node is a <code>DOM_Document</code> or a <code>DOM_DocumentType</code> 00158 * which is not used with any <code>DOM_Document</code> yet, this is 00159 * <code>null</code>. 00160 */ 00161 virtual XalanDocument* 00162 getOwnerDocument() const; 00163 00164 //@} 00165 /** @name Cloning function. */ 00166 //@{ 00167 00168 /** 00169 * Returns a duplicate of this node. 00170 * 00171 * This function serves as a generic copy constructor for nodes. 00172 * 00173 * The duplicate node has no parent ( 00174 * <code>parentNode</code> returns <code>null</code>.). 00175 * <br>Cloning an <code>Element</code> copies all attributes and their 00176 * values, including those generated by the XML processor to represent 00177 * defaulted attributes, but this method does not copy any text it contains 00178 * unless it is a deep clone, since the text is contained in a child 00179 * <code>Text</code> node. Cloning any other type of node simply returns a 00180 * copy of this node. 00181 * @param deep If <code>true</code>, recursively clone the subtree under the 00182 * specified node; if <code>false</code>, clone only the node itself (and 00183 * its attributes, if it is an <code>Element</code>). 00184 * @return The duplicate node. 00185 */ 00186 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE) 00187 virtual XalanNode* 00188 #else 00189 virtual XercesCommentBridge* 00190 #endif 00191 cloneNode(bool deep) const; 00192 00193 //@} 00194 /** @name Functions to modify the DOM Node. */ 00195 //@{ 00196 00197 /** 00198 * Inserts the node <code>newChild</code> before the existing child node 00199 * <code>refChild</code>. 00200 * 00201 * If <code>refChild</code> is <code>null</code>, 00202 * insert <code>newChild</code> at the end of the list of children. 00203 * <br>If <code>newChild</code> is a <code>DocumentFragment</code> object, 00204 * all of its children are inserted, in the same order, before 00205 * <code>refChild</code>. If the <code>newChild</code> is already in the 00206 * tree, it is first removed. Note that a <code>DOM_Node</code> that 00207 * has never been assigned to refer to an actual node is == null. 00208 * @param newChild The node to insert. 00209 * @param refChild The reference node, i.e., the node before which the new 00210 * node must be inserted. 00211 * @return The node being inserted. 00212 */ 00213 virtual XalanNode* 00214 insertBefore( 00215 XalanNode* newChild, 00216 XalanNode* refChild); 00217 00218 /** 00219 * Replaces the child node <code>oldChild</code> with <code>newChild</code> 00220 * in the list of children, and returns the <code>oldChild</code> node. 00221 * 00222 * If <CODE>newChild</CODE> is a <CODE>DOM_DocumentFragment</CODE> object, 00223 * <CODE>oldChild</CODE> is replaced by all of the <CODE>DOM_DocumentFragment</CODE> 00224 * children, which are inserted in the same order. 00225 * 00226 * If the <code>newChild</code> is already in the tree, it is first removed. 00227 * @param newChild The new node to put in the child list. 00228 * @param oldChild The node being replaced in the list. 00229 * @return The node replaced. 00230 */ 00231 virtual XalanNode* 00232 replaceChild( 00233 XalanNode* newChild, 00234 XalanNode* oldChild); 00235 00236 /** 00237 * Removes the child node indicated by <code>oldChild</code> from the list 00238 * of children, and returns it. 00239 * 00240 * @param oldChild The node being removed. 00241 * @return The node removed. 00242 */ 00243 virtual XalanNode* 00244 removeChild(XalanNode* oldChild); 00245 00246 /** 00247 * Adds the node <code>newChild</code> to the end of the list of children of 00248 * this node. 00249 * 00250 * If the <code>newChild</code> is already in the tree, it is 00251 * first removed. 00252 * @param newChild The node to add.If it is a <code>DocumentFragment</code> 00253 * object, the entire contents of the document fragment are moved into 00254 * the child list of this node 00255 * @return The node added. 00256 */ 00257 virtual XalanNode* 00258 appendChild(XalanNode* newChild); 00259 00260 //@} 00261 /** @name Query functions. */ 00262 //@{ 00263 00264 /** 00265 * This is a convenience method to allow easy determination of whether a 00266 * node has any children. 00267 * 00268 * @return <code>true</code> if the node has any children, 00269 * <code>false</code> if the node has no children. 00270 */ 00271 virtual bool 00272 hasChildNodes() const; 00273 00274 00275 //@} 00276 /** @name Set functions. */ 00277 //@{ 00278 00279 /** 00280 * Sets the value of the node. 00281 * 00282 * Any node which can have a nodeValue (@see getNodeValue) will 00283 * also accept requests to set it to a string. The exact response to 00284 * this varies from node to node -- Attribute, for example, stores 00285 * its values in its children and has to replace them with a new Text 00286 * holding the replacement value. 00287 * 00288 * For most types of Node, value is null and attempting to set it 00289 * will throw DOMException(NO_MODIFICATION_ALLOWED_ERR). This will 00290 * also be thrown if the node is read-only. 00291 */ 00292 virtual void 00293 setNodeValue(const XalanDOMString& nodeValue); 00294 00295 //@} 00296 /** @name Functions introduced in DOM Level 2. */ 00297 //@{ 00298 00299 /** 00300 * Puts all <CODE>DOM_Text</CODE> 00301 * nodes in the full depth of the sub-tree underneath this <CODE>DOM_Node</CODE>, 00302 * including attribute nodes, into a "normal" form where only markup (e.g., 00303 * tags, comments, processing instructions, CDATA sections, and entity 00304 * references) separates <CODE>DOM_Text</CODE> 00305 * nodes, i.e., there are no adjacent <CODE>DOM_Text</CODE> 00306 * nodes. This can be used to ensure that the DOM view of a document is the 00307 * same as if it were saved and re-loaded, and is useful when operations 00308 * (such as XPointer lookups) that depend on a particular document tree 00309 * structure are to be used. 00310 * <P><B>Note:</B> In cases where the document contains <CODE>DOM_CDATASections</CODE>, 00311 * the normalize operation alone may not be sufficient, since XPointers do 00312 * not differentiate between <CODE>DOM_Text</CODE> 00313 * nodes and <CODE>DOM_CDATASection</CODE> nodes.</P> 00314 */ 00315 virtual void 00316 normalize(); 00317 00318 /** 00319 * Tests whether the DOM implementation implements a specific 00320 * feature and that feature is supported by this node. 00321 * @param feature The string of the feature to test. This is the same 00322 * name as what can be passed to the method <code>hasFeature</code> on 00323 * <code>DOMImplementation</code>. 00324 * @param version This is the version number of the feature to test. In 00325 * Level 2, version 1, this is the string "2.0". If the version is not 00326 * specified, supporting any version of the feature will cause the 00327 * method to return <code>true</code>. 00328 * @return Returns <code>true</code> if the specified feature is supported 00329 * on this node, <code>false</code> otherwise. 00330 */ 00331 virtual bool 00332 isSupported( 00333 const XalanDOMString& feature, 00334 const XalanDOMString& version) const; 00335 00336 /** 00337 * Get the <em>namespace URI</em> of 00338 * this node, or <code>null</code> if it is unspecified. 00339 * <p> 00340 * This is not a computed value that is the result of a namespace lookup 00341 * based on an examination of the namespace declarations in scope. It is 00342 * merely the namespace URI given at creation time. 00343 * <p> 00344 * For nodes of any type other than <CODE>ELEMENT_NODE</CODE> and 00345 * <CODE>ATTRIBUTE_NODE</CODE> and nodes created with a DOM Level 1 method, 00346 * such as <CODE>createElement</CODE> from the <CODE>Document</CODE> 00347 * interface, this is always <CODE>null</CODE>. 00348 */ 00349 virtual const XalanDOMString& 00350 getNamespaceURI() const; 00351 00352 /** 00353 * Get the <em>namespace prefix</em> 00354 * of this node, or <code>null</code> if it is unspecified. 00355 */ 00356 virtual const XalanDOMString& 00357 getPrefix() const; 00358 00359 /** 00360 * Returns the local part of the <em>qualified name</em> of this node. 00361 * <p> 00362 * For nodes created with a DOM Level 1 method, such as 00363 * <code>createElement</code> from the <code>DOM_Document</code> interface, 00364 * it is null. 00365 */ 00366 virtual const XalanDOMString& 00367 getLocalName() const; 00368 00369 /** 00370 * Set the <em>namespace prefix</em> of this node. 00371 * <p> 00372 * Note that setting this attribute, when permitted, changes 00373 * the <CODE>nodeName</CODE> attribute, which holds the <EM>qualified 00374 * name</EM>, as well as the <CODE>tagName</CODE> and <CODE>name</CODE> 00375 * attributes of the <CODE>DOM_Element</CODE> and <CODE>DOM_Attr</CODE> 00376 * interfaces, when applicable. 00377 * <p> 00378 * Note also that changing the prefix of an 00379 * attribute, that is known to have a default value, does not make a new 00380 * attribute with the default value and the original prefix appear, since the 00381 * <CODE>namespaceURI</CODE> and <CODE>localName</CODE> do not change. 00382 * 00383 * @param prefix The prefix of this node. 00384 * @exception DOMException 00385 * INVALID_CHARACTER_ERR: Raised if the specified prefix contains 00386 * an illegal character. 00387 * <br> 00388 * NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. 00389 * <br> 00390 * NAMESPACE_ERR: Raised if the specified <CODE>prefix</CODE> is 00391 * malformed, if the specified prefix is "xml" and the 00392 * <CODE>namespaceURI</CODE> of this node is different from 00393 * "http://www.w3.org/XML/1998/namespace", if specified prefix is 00394 * "xmlns" and the <CODE>namespaceURI</CODE> is neither 00395 * <CODE>null</CODE> nor an empty string, or if the 00396 * <CODE>localName</CODE> is <CODE>null</CODE>. 00397 */ 00398 virtual void 00399 setPrefix(const XalanDOMString& prefix); 00400 00401 virtual bool 00402 isIndexed() const; 00403 00404 virtual IndexType 00405 getIndex() const; 00406 00407 //@} 00408 00409 // These interfaces are inherited from XalanCDATASection... 00410 00411 /** @name Getter functions. */ 00412 //@{ 00413 /** 00414 * Returns the character data of the node that implements this interface. 00415 * 00416 * The DOM implementation may not put arbitrary limits on the amount of data that 00417 * may be stored in a <code>CharacterData</code> node. However, 00418 * implementation limits may mean that the entirety of a node's data may 00419 * not fit into a single <code>DOMString</code>. In such cases, the user 00420 * may call <code>substringData</code> to retrieve the data in 00421 * appropriately sized pieces. 00422 * @exception DOMException 00423 * NO_MODIFICATION_ALLOWED_ERR: Raised when the node is readonly. 00424 * @exception DOMException 00425 * DOMSTRING_SIZE_ERR: Raised when it would return more characters than 00426 * fit in a <code>DOMString</code> variable on the implementation 00427 * platform. 00428 */ 00429 virtual const XalanDOMString& 00430 getData() const; 00431 00432 /** 00433 * Returns the number of characters that are available through <code>data</code> and 00434 * the <code>substringData</code> method below. 00435 * 00436 * This may have the value 00437 * zero, i.e., <code>CharacterData</code> nodes may be empty. 00438 */ 00439 virtual unsigned int 00440 getLength() const; 00441 00442 /** 00443 * Extracts a range of data from the node. 00444 * 00445 * @param offset Start offset of substring to extract. 00446 * @param count The number of characters to extract. 00447 * @return The specified substring. If the sum of <code>offset</code> and 00448 * <code>count</code> exceeds the <code>length</code>, then all 00449 * characters to the end of the data are returned. 00450 * @exception DOMException 00451 * INDEX_SIZE_ERR: Raised if the specified offset is negative or greater 00452 * than the number of characters in <code>data</code>, or if the 00453 * specified <code>count</code> is negative. 00454 * <br>DOMSTRING_SIZE_ERR: Raised if the specified range of text does not 00455 * fit into a <code>DOMString</code>. 00456 */ 00457 virtual XalanDOMString 00458 substringData( 00459 unsigned int offset, 00460 unsigned int count) const; 00461 00462 //@} 00463 /** @name Functions that set or change data. */ 00464 //@{ 00465 /** 00466 * Append the string to the end of the character data of the node. 00467 * 00468 * Upon success, <code>data</code> provides access to the concatenation of 00469 * <code>data</code> and the <code>DOMString</code> specified. 00470 * @param arg The <code>DOMString</code> to append. 00471 * @exception DOMException 00472 * NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. 00473 */ 00474 virtual void 00475 appendData(const XalanDOMString& arg); 00476 00477 /** 00478 * Insert a string at the specified character offset. 00479 * 00480 * @param offset The character offset at which to insert. 00481 * @param arg The <code>DOMString</code> to insert. 00482 * @exception DOMException 00483 * INDEX_SIZE_ERR: Raised if the specified offset is negative or greater 00484 * than the number of characters in <code>data</code>. 00485 * <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. 00486 */ 00487 virtual void 00488 insertData( 00489 unsigned int offset, 00490 const XalanDOMString& arg); 00491 00492 /** 00493 * Remove a range of characters from the node. 00494 * 00495 * Upon success, 00496 * <code>data</code> and <code>length</code> reflect the change. 00497 * @param offset The offset from which to remove characters. 00498 * @param count The number of characters to delete. If the sum of 00499 * <code>offset</code> and <code>count</code> exceeds <code>length</code> 00500 * then all characters from <code>offset</code> to the end of the data 00501 * are deleted. 00502 * @exception DOMException 00503 * INDEX_SIZE_ERR: Raised if the specified offset is negative or greater 00504 * than the number of characters in <code>data</code>, or if the 00505 * specified <code>count</code> is negative. 00506 * <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. 00507 */ 00508 virtual void 00509 deleteData( 00510 unsigned int offset, 00511 unsigned int count); 00512 00513 /** 00514 * Replace the characters starting at the specified character offset with 00515 * the specified string. 00516 * 00517 * @param offset The offset from which to start replacing. 00518 * @param count The number of characters to replace. If the sum of 00519 * <code>offset</code> and <code>count</code> exceeds <code>length</code> 00520 * , then all characters to the end of the data are replaced (i.e., the 00521 * effect is the same as a <code>remove</code> method call with the same 00522 * range, followed by an <code>append</code> method invocation). 00523 * @param arg The <code>DOMString</code> with which the range must be 00524 * replaced. 00525 * @exception DOMException 00526 * INDEX_SIZE_ERR: Raised if the specified offset is negative or greater 00527 * than the number of characters in <code>data</code>, or if the 00528 * specified <code>count</code> is negative. 00529 * <br>NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly. 00530 */ 00531 virtual void 00532 replaceData( 00533 unsigned int offset, 00534 unsigned int count, 00535 const XalanDOMString& arg); 00536 00537 /** 00538 * Get the Xerces node this instance represent. 00539 * 00540 * @return The Xerces node 00541 */ 00542 DOM_CommentType 00543 getXercesNode() const 00544 { 00545 return m_xercesNode; 00546 } 00547 00548 //@} 00549 00550 private: 00551 00552 // Not implemented... 00553 XercesCommentBridge(const XercesCommentBridge& theSource); 00554 00555 XercesCommentBridge& 00556 operator=(const XercesCommentBridge& theSource); 00557 00558 bool 00559 operator==(const XercesCommentBridge& theRHS) const; 00560 00561 // Data members... 00562 DOM_CommentType m_xercesNode; 00563 00564 const XercesBridgeNavigator& m_navigator; 00565 }; 00566 00567 00568 00569 XALAN_CPP_NAMESPACE_END 00570 00571 00572 00573 #endif // !defined(XERCESCOMMENTBRIDGE_HEADER_GUARD_1357924680)
Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.
Xalan-C++ XSLT Processor Version 1.11 |
|