Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.6

Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

XercesElementWrapper.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999-2002 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(XERCESELEMENTWRAPPER_HEADER_GUARD_1357924680)
00058 #define XERCESELEMENTWRAPPER_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 #include <xalanc/XercesParserLiaison/XercesParserLiaisonDefinitions.hpp>
00063 
00064 
00065 
00066 #include <map>
00067 
00068 
00069 
00070 #include <xalanc/XalanDOM/XalanElement.hpp>
00071 #include <xalanc/XalanDOM/XalanNodeList.hpp>
00072 
00073 
00074 
00075 #include <xalanc/PlatformSupport/DOMStringHelper.hpp>
00076 
00077 
00078 
00079 #include <xalanc/XercesParserLiaison/XercesNamedNodeMapWrapper.hpp>
00080 #include <xalanc/XercesParserLiaison/XercesWrapperTypes.hpp>
00081 
00082 
00083 
00084 XALAN_CPP_NAMESPACE_BEGIN
00085 
00086 
00087 
00088 class XercesWrapperNavigator;
00089 
00090 
00091 
00092 class XALAN_XERCESPARSERLIAISON_EXPORT XercesElementWrapper : public XalanElement, private XalanNodeList
00093 {
00094 public:
00095 
00096     XercesElementWrapper(
00097             const DOMElementType*           theXercesElement,
00098             const XercesWrapperNavigator&   theNavigator);
00099 
00100     virtual
00101     ~XercesElementWrapper();
00102 
00103 
00107     virtual const XalanDOMString&
00108     getNodeName() const;
00109 
00113     virtual const XalanDOMString&
00114     getNodeValue() const;
00115 
00119     virtual NodeType
00120     getNodeType() const;
00121 
00131     virtual XalanNode*
00132     getParentNode() const;
00133 
00147     virtual const XalanNodeList*
00148     getChildNodes() const;
00149 
00155     virtual XalanNode*
00156     getFirstChild() const;
00157 
00163     virtual XalanNode*
00164     getLastChild() const;
00165 
00171     virtual XalanNode*
00172     getPreviousSibling() const;
00173 
00179     virtual XalanNode*
00180     getNextSibling() const;
00181 
00186     virtual const XalanNamedNodeMap*
00187     getAttributes() const;
00188 
00198     virtual XalanDocument*
00199     getOwnerDocument() const;
00200 
00202 
00204 
00223 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00224     virtual XalanNode*
00225 #else
00226     virtual XercesElementWrapper*
00227 #endif
00228     cloneNode(bool deep) const;
00229 
00231 
00233 
00250     virtual XalanNode*
00251     insertBefore(
00252             XalanNode*  newChild,
00253             XalanNode*  refChild);
00254 
00268     virtual XalanNode*
00269     replaceChild(
00270             XalanNode*  newChild,
00271             XalanNode*  oldChild);
00272 
00280     virtual XalanNode*
00281     removeChild(XalanNode*  oldChild);
00282 
00294     virtual XalanNode*
00295     appendChild(XalanNode*  newChild);
00296 
00298 
00300 
00308     virtual bool
00309     hasChildNodes() const;
00310 
00311 
00313 
00315 
00316 
00330     virtual void
00331     setNodeValue(const XalanDOMString&      nodeValue);
00332 
00334 
00336 
00353     virtual void
00354     normalize();
00355 
00369     virtual bool
00370     isSupported(
00371             const XalanDOMString&   feature,
00372             const XalanDOMString&   version) const;
00373 
00387     virtual const XalanDOMString&
00388     getNamespaceURI() const;
00389 
00394     virtual const XalanDOMString&
00395     getPrefix() const;
00396 
00404     virtual const XalanDOMString&
00405     getLocalName() const;
00406 
00436     virtual void
00437     setPrefix(const XalanDOMString& prefix);
00438 
00439     virtual bool
00440     isIndexed() const;
00441 
00442     virtual IndexType
00443     getIndex() const;
00444 
00446 
00447     // These interfaces are inherited from XalanElement...
00448 
00457     virtual const XalanDOMString&
00458     getTagName() const;
00459 
00467     virtual const XalanDOMString&
00468     getAttribute(const XalanDOMString&      name) const;
00469 
00477     virtual XalanAttr*
00478     getAttributeNode(const XalanDOMString&      name) const;
00479 
00490     virtual XalanNodeList*
00491     getElementsByTagName(const XalanDOMString&      name) const;
00492 
00494 
00496 
00518     virtual void
00519     setAttribute(
00520             const XalanDOMString&   name, 
00521             const XalanDOMString&   value);
00522 
00542     virtual XalanAttr*
00543     setAttributeNode(XalanAttr*     newAttr);
00544 
00546 
00548     
00564     virtual XalanAttr*
00565     removeAttributeNode(XalanAttr*  oldAttr);
00566 
00579     virtual void
00580     removeAttribute(const XalanDOMString&   name);
00581 
00583 
00585 
00596     virtual const XalanDOMString&
00597     getAttributeNS(
00598             const XalanDOMString&   namespaceURI,
00599             const XalanDOMString&   localName) const;
00600 
00641     virtual void
00642     setAttributeNS(
00643             const XalanDOMString&   namespaceURI,
00644             const XalanDOMString&   qualifiedName,
00645             const XalanDOMString&   value);
00646 
00661     virtual void
00662     removeAttributeNS(
00663             const XalanDOMString&   namespaceURI,
00664             const XalanDOMString&   localName);
00665 
00676     virtual XalanAttr*
00677     getAttributeNodeNS(
00678             const XalanDOMString&   namespaceURI,
00679             const XalanDOMString&   localName) const;
00680 
00700     virtual XalanAttr*
00701     setAttributeNodeNS(XalanAttr*   newAttr);
00702 
00718     virtual XalanNodeList*
00719     getElementsByTagNameNS(
00720             const XalanDOMString&   namespaceURI,
00721             const XalanDOMString&   localName) const;
00722 
00728     const DOMElementType*
00729     getXercesNode() const
00730     {
00731         return m_xercesNode;
00732     }
00733 
00735 
00736 private:
00737 
00738     // Implementation of XalanNodeList for children.
00739     virtual XalanNode*
00740     item(unsigned int   index) const;
00741 
00742     virtual unsigned int
00743     getLength() const;
00744 
00745 
00746     // Not implemented...
00747     XercesElementWrapper(const XercesElementWrapper&    theSource);
00748 
00749     XalanNode&
00750     operator=(const XalanNode&  theSource);
00751 
00752     bool
00753     operator==(const XercesElementWrapper&  theRHS) const;
00754 
00755     // Data members...
00756     const DOMElementType* const     m_xercesNode;
00757 
00758     const XercesWrapperNavigator&   m_navigator;
00759 
00760     XercesNamedNodeMapWrapper       m_attributes;
00761 };
00762 
00763 
00764 
00765 XALAN_CPP_NAMESPACE_END
00766 
00767 
00768 
00769 #endif  // !defined(XERCESELEMENTWRAPPER_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.6
Copyright © 2000, 2001, 2002, 2003 The Apache Software Foundation. All Rights Reserved.