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(XALANNOTATION_HEADER_GUARD_1357924680) 00019 #define XALANNOTATION_HEADER_GUARD_1357924680 00020 00021 00022 00023 #include <xalanc/XalanDOM/XalanDOMDefinitions.hpp> 00024 #include <xalanc/XalanDOM/XalanNode.hpp> 00025 00026 00027 00028 XALAN_CPP_NAMESPACE_BEGIN 00029 00030 00031 00032 /* 00033 * <meta name="usage" content="deprecated"/> 00034 * 00035 * Base class for the DOM Notation interface. 00036 * 00037 * This class is deprecated and should not be used!! 00038 */ 00039 00040 class XALAN_DOM_EXPORT XalanNotation : public XalanNode 00041 { 00042 public: 00043 00044 XalanNotation(); 00045 00046 virtual 00047 ~XalanNotation(); 00048 00049 00050 // These interfaces are inherited from XalanNode... 00051 virtual const XalanDOMString& 00052 getNodeName() const = 0; 00053 00054 /** 00055 * Gets the value of this node, depending on its type. 00056 */ 00057 virtual const XalanDOMString& 00058 getNodeValue() const = 0; 00059 00060 /** 00061 * An enum value representing the type of the underlying object. 00062 */ 00063 virtual NodeType 00064 getNodeType() const = 0; 00065 00066 /** 00067 * Gets the parent of this node. 00068 * 00069 * All nodes, except <code>Document</code>, 00070 * <code>DocumentFragment</code>, and <code>Attr</code> may have a parent. 00071 * However, if a node has just been created and not yet added to the tree, 00072 * or if it has been removed from the tree, a <code>null</code> Node 00073 * is returned. 00074 */ 00075 virtual XalanNode* 00076 getParentNode() const = 0; 00077 00078 /** 00079 * Gets a <code>NodeList</code> that contains all children of this node. 00080 * 00081 * If there 00082 * are no children, this is a <code>NodeList</code> containing no nodes. 00083 * The content of the returned <code>NodeList</code> is "live" in the sense 00084 * that, for instance, changes to the children of the node object that 00085 * it was created from are immediately reflected in the nodes returned by 00086 * the <code>NodeList</code> accessors; it is not a static snapshot of the 00087 * content of the node. This is true for every <code>NodeList</code>, 00088 * including the ones returned by the <code>getElementsByTagName</code> 00089 * method. 00090 */ 00091 virtual const XalanNodeList* 00092 getChildNodes() const = 0; 00093 00094 /** 00095 * Gets the first child of this node. 00096 * 00097 * If there is no such node, this returns <code>null</code>. 00098 */ 00099 virtual XalanNode* 00100 getFirstChild() const = 0; 00101 00102 /** 00103 * Gets the last child of this node. 00104 * 00105 * If there is no such node, this returns <code>null</code>. 00106 */ 00107 virtual XalanNode* 00108 getLastChild() const = 0; 00109 00110 /** 00111 * Gets the node immediately preceding this node. 00112 * 00113 * If there is no such node, this returns <code>null</code>. 00114 */ 00115 virtual XalanNode* 00116 getPreviousSibling() const = 0; 00117 00118 /** 00119 * Gets the node immediately following this node. 00120 * 00121 * If there is no such node, this returns <code>null</code>. 00122 */ 00123 virtual XalanNode* 00124 getNextSibling() const = 0; 00125 00126 /** 00127 * Gets a <code>NamedNodeMap</code> containing the attributes of this node (if it 00128 * is an <code>Element</code>) or <code>null</code> otherwise. 00129 */ 00130 virtual const XalanNamedNodeMap* 00131 getAttributes() const = 0; 00132 00133 /** 00134 * Gets the <code>Document</code> object associated with this node. 00135 * 00136 * This is also 00137 * the <code>Document</code> object used to create new nodes. When this 00138 * node is a <code>Document</code> or a <code>DocumentType</code> 00139 * which is not used with any <code>Document</code> yet, this is 00140 * <code>null</code>. 00141 */ 00142 virtual XalanDocument* 00143 getOwnerDocument() const = 0; 00144 00145 /** 00146 * Get the <em>namespace URI</em> of 00147 * this node, or <code>null</code> if it is unspecified. 00148 * <p> 00149 * This is not a computed value that is the result of a namespace lookup 00150 * based on an examination of the namespace declarations in scope. It is 00151 * merely the namespace URI given at creation time. 00152 * <p> 00153 * For nodes of any type other than <CODE>ELEMENT_NODE</CODE> and 00154 * <CODE>ATTRIBUTE_NODE</CODE> and nodes created with a DOM Level 1 method, 00155 * such as <CODE>createElement</CODE> from the <CODE>Document</CODE> 00156 * interface, this is always <CODE>null</CODE>. 00157 */ 00158 virtual const XalanDOMString& 00159 getNamespaceURI() const = 0; 00160 00161 /** 00162 * Get the <em>namespace prefix</em> 00163 * of this node, or <code>null</code> if it is unspecified. 00164 */ 00165 virtual const XalanDOMString& 00166 getPrefix() const = 0; 00167 00168 /** 00169 * Returns the local part of the <em>qualified name</em> of this node. 00170 * <p> 00171 * For nodes created with a DOM Level 1 method, such as 00172 * <code>createElement</code> from the <code>Document</code> interface, 00173 * it is null. 00174 */ 00175 virtual const XalanDOMString& 00176 getLocalName() const = 0; 00177 00178 /** 00179 * Determine if the document is node-order indexed. 00180 * 00181 * @return true if the document is indexed, otherwise false. 00182 */ 00183 virtual bool 00184 isIndexed() const = 0; 00185 00186 /** 00187 * Get the node's index. Valid only if the owner document 00188 * reports that the document is node-order indexed. 00189 * 00190 * @return The index value, or 0 if the node is not indexed. 00191 */ 00192 virtual IndexType 00193 getIndex() const = 0; 00194 00195 // These interfaces are new to XalanNotation... 00196 00197 /** 00198 * Get the public identifier of this notation. 00199 * 00200 * If the public identifier was not 00201 * specified, this is <code>null</code>. 00202 * @return Returns the public identifier of the notation 00203 */ 00204 virtual const XalanDOMString& 00205 getPublicId() const = 0; 00206 00207 /** 00208 * Get the system identifier of this notation. 00209 * 00210 * If the system identifier was not 00211 * specified, this is <code>null</code>. 00212 * @return Returns the system identifier of the notation 00213 */ 00214 virtual const XalanDOMString& 00215 getSystemId() const = 0; 00216 00217 protected: 00218 00219 XalanNotation(const XalanNotation& theSource); 00220 00221 XalanNotation& 00222 operator=(const XalanNotation& theSource); 00223 00224 bool 00225 operator==(const XalanNotation& theRHS) const; 00226 00227 private: 00228 }; 00229 00230 00231 00232 XALAN_CPP_NAMESPACE_END 00233 00234 00235 00236 #endif // !defined(XALANNOTATION_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 |
|