Xalan-C++ API Documentation

00001 /*
00002  * Copyright 1999-2004 The Apache Software Foundation.
00003  *
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  *
00008  *     http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 #if !defined(XERCESCOMMENTWRAPPER_HEADER_GUARD_1357924680)
00017 #define XERCESCOMMENTWRAPPER_HEADER_GUARD_1357924680
00018 
00019 
00020 
00021 #include <xalanc/XercesParserLiaison/XercesParserLiaisonDefinitions.hpp>
00022 
00023 #include <xalanc/Include/XalanMemMgrAutoPtr.hpp>
00024 
00025 #include <xalanc/XalanDOM/XalanComment.hpp>
00026 #include <xalanc/XercesParserLiaison/XercesWrapperTypes.hpp>
00027 
00028 
00029 
00030 XALAN_CPP_NAMESPACE_BEGIN
00031 
00032 
00033 
00034 class XercesWrapperNavigator;
00035 
00036 
00037 
00038 class XALAN_XERCESPARSERLIAISON_EXPORT XercesCommentWrapper : public XalanComment
00039 {
00040 public:
00041 
00042     XercesCommentWrapper(
00043             const DOMCommentType*           theXercesComment,
00044             const XercesWrapperNavigator&   theNavigator);
00045 
00046     static XercesCommentWrapper*
00047     create( MemoryManagerType& theManager,
00048             const DOMCommentType*           theXercesComment,
00049             const XercesWrapperNavigator&   theNavigator);
00050 
00051     virtual
00052     ~XercesCommentWrapper();
00053 
00054 
00058     virtual const XalanDOMString&
00059     getNodeName() const;
00060 
00064     virtual const XalanDOMString&
00065     getNodeValue() const;
00066 
00070     virtual NodeType
00071     getNodeType() const;
00072 
00082     virtual XalanNode*
00083     getParentNode() const;
00084 
00098     virtual const XalanNodeList*
00099     getChildNodes() const;
00100 
00106     virtual XalanNode*
00107     getFirstChild() const;
00108 
00114     virtual XalanNode*
00115     getLastChild() const;
00116 
00122     virtual XalanNode*
00123     getPreviousSibling() const;
00124 
00130     virtual XalanNode*
00131     getNextSibling() const;
00132 
00137     virtual const XalanNamedNodeMap*
00138     getAttributes() const;
00139 
00149     virtual XalanDocument*
00150     getOwnerDocument() const;
00151 
00153 
00155 
00174 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00175     virtual XalanNode*
00176 #else
00177     virtual XercesCommentWrapper*
00178 #endif
00179     cloneNode(bool deep) const;
00180 
00182 
00184 
00201     virtual XalanNode*
00202     insertBefore(
00203             XalanNode*  newChild,
00204             XalanNode*  refChild);
00205 
00219     virtual XalanNode*
00220     replaceChild(
00221             XalanNode*  newChild,
00222             XalanNode*  oldChild);
00223 
00231     virtual XalanNode*
00232     removeChild(XalanNode*  oldChild);
00233 
00245     virtual XalanNode*
00246     appendChild(XalanNode*  newChild);
00247 
00249 
00251 
00259     virtual bool
00260     hasChildNodes() const;
00261 
00262 
00264 
00266 
00280     virtual void
00281     setNodeValue(const XalanDOMString&      nodeValue);
00282 
00284 
00286 
00303     virtual void
00304     normalize();
00305 
00319     virtual bool
00320     isSupported(
00321             const XalanDOMString&   feature,
00322             const XalanDOMString&   version) const;
00323 
00337     virtual const XalanDOMString&
00338     getNamespaceURI() const;
00339 
00344     virtual const XalanDOMString&
00345     getPrefix() const;
00346 
00354     virtual const XalanDOMString&
00355     getLocalName() const;
00356 
00386     virtual void
00387     setPrefix(const XalanDOMString& prefix);
00388 
00389     virtual bool
00390     isIndexed() const;
00391 
00392     virtual IndexType
00393     getIndex() const;
00394 
00396 
00397     // These interfaces are inherited from XalanCDATASection...
00398 
00401 
00417     virtual const XalanDOMString&
00418     getData() const;
00419 
00427     virtual unsigned int
00428     getLength() const;
00429 
00445     virtual XalanDOMString&
00446     substringData(
00447             unsigned int    offset, 
00448             unsigned int    count,
00449             XalanDOMString& theResult) const;
00450 
00452 
00454 
00463     virtual void
00464     appendData(const XalanDOMString&    arg);
00465 
00476     virtual void
00477     insertData(
00478             unsigned int            offset,
00479             const  XalanDOMString&  arg);
00480 
00497     virtual void
00498     deleteData(
00499             unsigned int    offset, 
00500             unsigned int    count);
00501 
00520     virtual void
00521     replaceData(
00522             unsigned int            offset, 
00523             unsigned int            count, 
00524             const XalanDOMString&   arg);
00525 
00531     const DOMCommentType*
00532     getXercesNode() const
00533     {
00534         return m_xercesNode;
00535     }
00536 
00538 
00539 private:
00540 
00541     // Not implemented...
00542     XercesCommentWrapper(const XercesCommentWrapper&    theSource);
00543 
00544     XercesCommentWrapper&
00545     operator=(const XercesCommentWrapper&   theSource);
00546 
00547     bool
00548     operator==(const XercesCommentWrapper&  theRHS) const;
00549 
00550     // Data members...
00551     const DOMCommentType* const     m_xercesNode;
00552 
00553     const XercesWrapperNavigator&   m_navigator;
00554 };
00555 
00556 
00557 
00558 XALAN_CPP_NAMESPACE_END
00559 
00560 
00561 #endif  // !defined(XERCESCOMMENTWRAPPER_HEADER_GUARD_1357924680)
Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.
Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

XercesCommentWrapper.hpp
