Xalan-C++ API Documentation

The Xalan C++ XSL Transformer Version 1.1

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

XalanSourceTreeElement.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999-2000 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(XALANSOURCETREEELEMENT_HEADER_GUARD_1357924680)
00058 #define XALANSOURCETREEELEMENT_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 #include <XalanSourceTree/XalanSourceTreeDefinitions.hpp>
00063 
00064 
00065 
00066 #include <XalanDOM/XalanDOMString.hpp>
00067 #include <XalanDOM/XalanElement.hpp>
00068 #include <XalanDOM/XalanNamedNodeMap.hpp>
00069 
00070 
00071 
00072 class XalanSourceTreeAttr;
00073 class XalanSourceTreeComment;
00074 class XalanSourceTreeDocument;
00075 class XalanSourceTreeProcessingInstruction;
00076 class XalanSourceTreeText;
00077 
00078 
00079 
00080 class XALAN_XALANSOURCETREE_EXPORT XalanSourceTreeElement : public XalanElement, private XalanNamedNodeMap
00081 {
00082 public:
00083 
00084     typedef unsigned long   AttributesCountType;
00085 
00098     XalanSourceTreeElement(
00099             const XalanDOMString&       theTagName,
00100             XalanSourceTreeDocument*    theOwnerDocument,
00101             XalanSourceTreeAttr**       theAttributes,
00102             AttributesCountType         theAttributeCount,
00103             XalanSourceTreeElement*     theParentElement = 0,
00104             XalanNode*                  thePreviousSibling = 0,
00105             XalanNode*                  theNextSibling = 0,
00106             unsigned int                theIndex = 0);
00107 
00108     virtual
00109     ~XalanSourceTreeElement();
00110 
00111 
00115     virtual const XalanDOMString&
00116     getNodeName() const;
00117 
00121     virtual const XalanDOMString&
00122     getNodeValue() const;
00123 
00127     virtual NodeType
00128     getNodeType() const;
00129 
00139     virtual XalanNode*
00140     getParentNode() const;
00141 
00155     virtual const XalanNodeList*
00156     getChildNodes() const;
00157 
00163     virtual XalanNode*
00164     getFirstChild() const;
00165 
00171     virtual XalanNode*
00172     getLastChild() const;
00173 
00179     virtual XalanNode*
00180     getPreviousSibling() const;
00181 
00187     virtual XalanNode*
00188     getNextSibling() const;
00189 
00194     virtual const XalanNamedNodeMap*
00195     getAttributes() const;
00196 
00206     virtual XalanDocument*
00207     getOwnerDocument() const;
00208 
00210 
00212 
00231 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00232     virtual XalanNode*
00233 #else
00234     virtual XalanSourceTreeElement*
00235 #endif
00236     cloneNode(bool deep) const;
00237 
00239 
00241 
00258     virtual XalanNode*
00259     insertBefore(
00260             XalanNode*  newChild,
00261             XalanNode*  refChild);
00262 
00276     virtual XalanNode*
00277     replaceChild(
00278             XalanNode*  newChild,
00279             XalanNode*  oldChild);
00280 
00288     virtual XalanNode*
00289     removeChild(XalanNode*  oldChild);
00290 
00302     virtual XalanNode*
00303     appendChild(XalanNode*  newChild);
00304 
00306 
00308 
00316     virtual bool
00317     hasChildNodes() const;
00318 
00319 
00321 
00323 
00324 
00338     virtual void
00339     setNodeValue(const XalanDOMString&      nodeValue);
00340 
00342 
00344 
00361     virtual void
00362     normalize();
00363 
00377     virtual bool
00378     supports(
00379             const XalanDOMString&   feature,
00380             const XalanDOMString&   version) const;
00381 
00395     virtual const XalanDOMString&
00396     getNamespaceURI() const;
00397 
00402     virtual const XalanDOMString&
00403     getPrefix() const;
00404 
00412     virtual const XalanDOMString&
00413     getLocalName() const;
00414 
00444     virtual void
00445     setPrefix(const XalanDOMString& prefix);
00446 
00447     virtual bool
00448     isIndexed() const;
00449 
00450     virtual unsigned long
00451     getIndex() const;
00452 
00454 
00455     // These interfaces are inherited from XalanElement...
00456 
00465     virtual const XalanDOMString&
00466     getTagName() const;
00467 
00475     virtual const XalanDOMString&
00476     getAttribute(const XalanDOMString&      name) const;
00477 
00485     virtual XalanAttr*
00486     getAttributeNode(const XalanDOMString&      name) const;
00487 
00498     virtual XalanNodeList*
00499     getElementsByTagName(const XalanDOMString&  name) const;
00500 
00502 
00504 
00526     virtual void
00527     setAttribute(
00528             const XalanDOMString&   name, 
00529             const XalanDOMString&   value);
00530 
00550     virtual XalanAttr*
00551     setAttributeNode(XalanAttr*     newAttr);
00552 
00554 
00556     
00572     virtual XalanAttr*
00573     removeAttributeNode(XalanAttr*  oldAttr);
00574 
00587     virtual void
00588     removeAttribute(const XalanDOMString&   name);
00589 
00591 
00593 
00604     virtual const XalanDOMString&
00605     getAttributeNS(
00606             const XalanDOMString&   namespaceURI,
00607             const XalanDOMString&   localName) const;
00608 
00649     virtual void
00650     setAttributeNS(
00651             const XalanDOMString&   namespaceURI,
00652             const XalanDOMString&   qualifiedName,
00653             const XalanDOMString&   value);
00654 
00669     virtual void
00670     removeAttributeNS(
00671             const XalanDOMString&   namespaceURI,
00672             const XalanDOMString&   localName);
00673 
00684     virtual XalanAttr*
00685     getAttributeNodeNS(
00686             const XalanDOMString&   namespaceURI,
00687             const XalanDOMString&   localName) const;
00688 
00708     virtual XalanAttr*
00709     setAttributeNodeNS(XalanAttr*   newAttr);
00710 
00726     virtual XalanNodeList*
00727     getElementsByTagNameNS(
00728             const XalanDOMString&   namespaceURI,
00729             const XalanDOMString&   localName) const;
00730 
00732 
00733 
00734     // public interfaces not inherited from XalanElement...
00735 
00736     XalanSourceTreeDocument*
00737     getDocument() const
00738     {
00739         return m_ownerDocument;
00740     }
00741 
00742     XalanSourceTreeElement*
00743     getParentElement() const
00744     {
00745         return m_parentElement;
00746     }
00747 
00748     void
00749     setParentElement(XalanSourceTreeElement*    theParent)
00750     {
00751         m_parentElement = theParent;
00752     }
00753 
00754     void
00755     setPreviousSibling(XalanSourceTreeComment*  thePreviousSibling);
00756 
00757     void
00758     setPreviousSibling(XalanSourceTreeElement*  thePreviousSibling);
00759 
00760     void
00761     setPreviousSibling(XalanSourceTreeProcessingInstruction*    thePreviousSibling);
00762 
00763     void
00764     setPreviousSibling(XalanSourceTreeText*     thePreviousSibling);
00765 
00766     void
00767     appendSiblingNode(XalanSourceTreeComment*   theSibling);
00768 
00769     void
00770     appendSiblingNode(XalanSourceTreeElement*   theSibling);
00771 
00772     void
00773     appendSiblingNode(XalanSourceTreeProcessingInstruction*     theSibling);
00774 
00775     void
00776     appendSiblingNode(XalanSourceTreeText*  theSibling);
00777 
00778     void
00779     appendChildNode(XalanSourceTreeComment*     theChild);
00780 
00781     void
00782     appendChildNode(XalanSourceTreeElement*     theChild);
00783 
00784     void
00785     appendChildNode(XalanSourceTreeProcessingInstruction*   theChild);
00786 
00787     void
00788     appendChildNode(XalanSourceTreeText*    theChild);
00789 
00790     void
00791     setIndex(unsigned int   theIndex)
00792     {
00793         m_index = theIndex;
00794     }
00795 
00796     unsigned int
00797     getAttributeCount() const
00798     {
00799         return m_attributeCount;
00800     }
00801 
00802     XalanSourceTreeAttr*
00803     getAttributeByIndex(unsigned int    index) const
00804     {
00805         return index < m_attributeCount ? m_attributes[index] : 0;
00806     }
00807 
00808 protected:
00809 
00810     XalanSourceTreeElement(
00811             const XalanSourceTreeElement&   theSource,
00812             bool                            deep = false);
00813 
00814 private:
00815 
00816     // These are from XalanNamedNodeMap...
00817 
00818     virtual XalanNode*
00819     setNamedItem(XalanNode*     arg);
00820 
00821     virtual XalanNode*
00822     item(unsigned int   index) const;
00823 
00824     virtual XalanNode*
00825     getNamedItem(const XalanDOMString&  name) const;
00826 
00827     virtual unsigned int
00828     getLength() const;
00829 
00830     virtual XalanNode*
00831     removeNamedItem(const XalanDOMString&   name);
00832 
00833     virtual XalanNode*
00834     getNamedItemNS(
00835             const XalanDOMString&   namespaceURI,
00836             const XalanDOMString&   localName) const;
00837 
00838     virtual XalanNode*
00839     setNamedItemNS(XalanNode*   arg);
00840 
00841     virtual XalanNode*
00842     removeNamedItemNS(
00843             const XalanDOMString&   namespaceURI,
00844             const XalanDOMString&   localName);
00845 
00846 
00847     // Not implemented...
00848     XalanSourceTreeElement&
00849     operator=(const XalanSourceTreeElement&     theSource);
00850 
00851     bool
00852     operator==(const XalanSourceTreeElement&    theRHS) const;
00853 
00854 
00855     // Data members...
00856     const XalanDOMString&           m_tagName;
00857 
00858     XalanSourceTreeDocument*        m_ownerDocument;
00859 
00860     XalanSourceTreeElement*         m_parentElement;
00861 
00862     XalanNode*                      m_previousSibling;
00863 
00864     XalanNode*                      m_nextSibling;
00865 
00866     XalanNode*                      m_firstChild;
00867 
00868     unsigned int                    m_index;
00869 
00870     XalanSourceTreeAttr* const *    m_attributes;
00871 
00872     const AttributesCountType       m_attributeCount;
00873 };
00874 
00875 
00876 
00877 #endif  // !defined(XALANSOURCETREEELEMENT_HEADER_GUARD_1357924680)

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

Xalan-C++ XSL Transformer Version 1.1
Copyright © 2000, 2001 The Apache Software Foundation. All Rights Reserved.