Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.7

Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

XercesCommentWrapper.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999-2004 The Apache Software Foundation.  All rights 
00006  * reserved.
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions
00010  * are met:
00011  *
00012  * 1. Redistributions of source code must retain the above copyright
00013  *    notice, this list of conditions and the following disclaimer. 
00014  *
00015  * 2. Redistributions in binary form must reproduce the above copyright
00016  *    notice, this list of conditions and the following disclaimer in
00017  *    the documentation and/or other materials provided with the
00018  *    distribution.
00019  *
00020  * 3. The end-user documentation included with the redistribution,
00021  *    if any, must include the following acknowledgment:  
00022  *       "This product includes software developed by the
00023  *        Apache Software Foundation (http://www.apache.org/)."
00024  *    Alternately, this acknowledgment may appear in the software itself,
00025  *    if and wherever such third-party acknowledgments normally appear.
00026  *
00027  * 4. The names "Xalan" and "Apache Software Foundation" must
00028  *    not be used to endorse or promote products derived from this
00029  *    software without prior written permission. For written 
00030  *    permission, please contact apache@apache.org.
00031  *
00032  * 5. Products derived from this software may not be called "Apache",
00033  *    nor may "Apache" appear in their name, without prior written
00034  *    permission of the Apache Software Foundation.
00035  *
00036  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00037  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00038  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00039  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00040  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00041  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00042  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00043  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00044  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00045  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00046  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00047  * SUCH DAMAGE.
00048  * ====================================================================
00049  *
00050  * This software consists of voluntary contributions made by many
00051  * individuals on behalf of the Apache Software Foundation and was
00052  * originally based on software copyright (c) 1999, International
00053  * Business Machines, Inc., http://www.ibm.com.  For more
00054  * information on the Apache Software Foundation, please see
00055  * <http://www.apache.org/>.
00056  */
00057 #if !defined(XERCESCOMMENTWRAPPER_HEADER_GUARD_1357924680)
00058 #define XERCESCOMMENTWRAPPER_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 #include <xalanc/XercesParserLiaison/XercesParserLiaisonDefinitions.hpp>
00063 
00064 
00065 
00066 #include <xalanc/XalanDOM/XalanComment.hpp>
00067 #include <xalanc/XercesParserLiaison/XercesWrapperTypes.hpp>
00068 
00069 
00070 
00071 XALAN_CPP_NAMESPACE_BEGIN
00072 
00073 
00074 
00075 class XercesWrapperNavigator;
00076 
00077 
00078 
00079 class XALAN_XERCESPARSERLIAISON_EXPORT XercesCommentWrapper : public XalanComment
00080 {
00081 public:
00082 
00083     XercesCommentWrapper(
00084             const DOMCommentType*           theXercesComment,
00085             const XercesWrapperNavigator&   theNavigator);
00086 
00087     virtual
00088     ~XercesCommentWrapper();
00089 
00090 
00094     virtual const XalanDOMString&
00095     getNodeName() const;
00096 
00100     virtual const XalanDOMString&
00101     getNodeValue() const;
00102 
00106     virtual NodeType
00107     getNodeType() const;
00108 
00118     virtual XalanNode*
00119     getParentNode() const;
00120 
00134     virtual const XalanNodeList*
00135     getChildNodes() const;
00136 
00142     virtual XalanNode*
00143     getFirstChild() const;
00144 
00150     virtual XalanNode*
00151     getLastChild() const;
00152 
00158     virtual XalanNode*
00159     getPreviousSibling() const;
00160 
00166     virtual XalanNode*
00167     getNextSibling() const;
00168 
00173     virtual const XalanNamedNodeMap*
00174     getAttributes() const;
00175 
00185     virtual XalanDocument*
00186     getOwnerDocument() const;
00187 
00189 
00191 
00210 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00211     virtual XalanNode*
00212 #else
00213     virtual XercesCommentWrapper*
00214 #endif
00215     cloneNode(bool deep) const;
00216 
00218 
00220 
00237     virtual XalanNode*
00238     insertBefore(
00239             XalanNode*  newChild,
00240             XalanNode*  refChild);
00241 
00255     virtual XalanNode*
00256     replaceChild(
00257             XalanNode*  newChild,
00258             XalanNode*  oldChild);
00259 
00267     virtual XalanNode*
00268     removeChild(XalanNode*  oldChild);
00269 
00281     virtual XalanNode*
00282     appendChild(XalanNode*  newChild);
00283 
00285 
00287 
00295     virtual bool
00296     hasChildNodes() const;
00297 
00298 
00300 
00302 
00316     virtual void
00317     setNodeValue(const XalanDOMString&      nodeValue);
00318 
00320 
00322 
00339     virtual void
00340     normalize();
00341 
00355     virtual bool
00356     isSupported(
00357             const XalanDOMString&   feature,
00358             const XalanDOMString&   version) const;
00359 
00373     virtual const XalanDOMString&
00374     getNamespaceURI() const;
00375 
00380     virtual const XalanDOMString&
00381     getPrefix() const;
00382 
00390     virtual const XalanDOMString&
00391     getLocalName() const;
00392 
00422     virtual void
00423     setPrefix(const XalanDOMString& prefix);
00424 
00425     virtual bool
00426     isIndexed() const;
00427 
00428     virtual IndexType
00429     getIndex() const;
00430 
00432 
00433     // These interfaces are inherited from XalanCDATASection...
00434 
00437 
00453     virtual const XalanDOMString&
00454     getData() const;
00455 
00463     virtual unsigned int
00464     getLength() const;
00465 
00481     virtual XalanDOMString
00482     substringData(
00483             unsigned int    offset, 
00484             unsigned int    count) const;
00485 
00487 
00489 
00498     virtual void
00499     appendData(const XalanDOMString&    arg);
00500 
00511     virtual void
00512     insertData(
00513             unsigned int            offset,
00514             const  XalanDOMString&  arg);
00515 
00532     virtual void
00533     deleteData(
00534             unsigned int    offset, 
00535             unsigned int    count);
00536 
00555     virtual void
00556     replaceData(
00557             unsigned int            offset, 
00558             unsigned int            count, 
00559             const XalanDOMString&   arg);
00560 
00566     const DOMCommentType*
00567     getXercesNode() const
00568     {
00569         return m_xercesNode;
00570     }
00571 
00573 
00574 private:
00575 
00576     // Not implemented...
00577     XercesCommentWrapper(const XercesCommentWrapper&    theSource);
00578 
00579     XercesCommentWrapper&
00580 	operator=(const XercesCommentWrapper&  theSource);
00581 
00582     bool
00583 	operator==(const XercesCommentWrapper& theRHS) const;
00584 
00585     // Data members...
00586     const DOMCommentType* const     m_xercesNode;
00587 
00588     const XercesWrapperNavigator&   m_navigator;
00589 };
00590 
00591 
00592 
00593 XALAN_CPP_NAMESPACE_END
00594 
00595 
00596 #endif  // !defined(XERCESCOMMENTWRAPPER_HEADER_GUARD_1357924680)

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.7
Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.