Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.6

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

XalanSourceTreeElementA.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999-2003 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(XALANSOURCETREEELEMENTA_HEADER_GUARD_1357924680)
00058 #define XALANSOURCETREEELEMENTA_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 #include <xalanc/XalanSourceTree/XalanSourceTreeDefinitions.hpp>
00063 
00064 
00065 
00066 #include <xalanc/XalanDOM/XalanNamedNodeMap.hpp>
00067 
00068 
00069 
00070 #include <xalanc/XalanSourceTree/XalanSourceTreeElement.hpp>
00071 
00072 
00073 
00074 XALAN_CPP_NAMESPACE_BEGIN
00075 
00076 
00077 
00078 class XALAN_XALANSOURCETREE_EXPORT XalanSourceTreeElementA : public XalanSourceTreeElement, private XalanNamedNodeMap
00079 {
00080 public:
00081 
00082     typedef unsigned long   AttributesCountType;
00083 
00096     XalanSourceTreeElementA(
00097             const XalanDOMString&       theTagName,
00098             XalanSourceTreeDocument*    theOwnerDocument,
00099             XalanSourceTreeAttr**       theAttributes,
00100             AttributesCountType         theAttributeCount,
00101             XalanNode*                  theParentNode = 0,
00102             XalanNode*                  thePreviousSibling = 0,
00103             XalanNode*                  theNextSibling = 0,
00104             IndexType                   theIndex = 0);
00105 
00106     virtual
00107     ~XalanSourceTreeElementA();
00108 
00109 
00110     virtual const XalanNamedNodeMap*
00111     getAttributes() const;
00112 
00113 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00114     virtual XalanNode*
00115 #else
00116     virtual XalanSourceTreeElementA*
00117 #endif
00118     cloneNode(bool deep) const;
00119 
00120     virtual const XalanDOMString&
00121     getNamespaceURI() const;
00122 
00123     virtual const XalanDOMString&
00124     getPrefix() const;
00125 
00126     virtual const XalanDOMString&
00127     getLocalName() const;
00128 
00129     virtual const XalanDOMString&
00130     getAttribute(const XalanDOMString&      name) const;
00131 
00132     virtual XalanAttr*
00133     getAttributeNode(const XalanDOMString&      name) const;
00134 
00135     virtual const XalanDOMString&
00136     getAttributeNS(
00137             const XalanDOMString&   namespaceURI,
00138             const XalanDOMString&   localName) const;
00139 
00140     virtual XalanAttr*
00141     getAttributeNodeNS(
00142             const XalanDOMString&   namespaceURI,
00143             const XalanDOMString&   localName) const;
00144 
00145 
00146     // public interfaces not inherited from XalanElement...
00147 
00148     AttributesCountType
00149     getAttributeCount() const
00150     {
00151         return m_attributeCount;
00152     }
00153 
00154     XalanSourceTreeAttr*
00155     getAttributeByIndex(AttributesCountType     index) const
00156     {
00157         return index < m_attributeCount ? m_attributes[index] : 0;
00158     }
00159 
00160     XalanSourceTreeElementA*
00161     clone(bool  deep) const
00162     {
00163         return new XalanSourceTreeElementA(*this, deep);
00164     }
00165 
00166 protected:
00167 
00168     XalanSourceTreeElementA(
00169             const XalanSourceTreeElementA&  theSource,
00170             bool                            deep = false);
00171 
00172 private:
00173 
00174     // These are from XalanNamedNodeMap...
00175 
00176     virtual XalanNode*
00177     setNamedItem(XalanNode*     arg);
00178 
00179     virtual XalanNode*
00180     item(unsigned int   index) const;
00181 
00182     virtual XalanNode*
00183     getNamedItem(const XalanDOMString&  name) const;
00184 
00185     virtual unsigned int
00186     getLength() const;
00187 
00188     virtual XalanNode*
00189     removeNamedItem(const XalanDOMString&   name);
00190 
00191     virtual XalanNode*
00192     getNamedItemNS(
00193             const XalanDOMString&   namespaceURI,
00194             const XalanDOMString&   localName) const;
00195 
00196     virtual XalanNode*
00197     setNamedItemNS(XalanNode*   arg);
00198 
00199     virtual XalanNode*
00200     removeNamedItemNS(
00201             const XalanDOMString&   namespaceURI,
00202             const XalanDOMString&   localName);
00203 
00204 
00205     // Not implemented...
00206     XalanSourceTreeElementA&
00207 	operator=(const XalanSourceTreeElementA&   theSource);
00208 
00209     bool
00210 	operator==(const XalanSourceTreeElementA&  theRHS) const;
00211 
00212 
00213     // Data members...
00214     XalanSourceTreeAttr* const *    m_attributes;
00215 
00216     const AttributesCountType       m_attributeCount;
00217 };
00218 
00219 
00220 
00221 XALAN_CPP_NAMESPACE_END
00222 
00223 
00224 
00225 #endif  // !defined(XALANSOURCETREEELEMENTA_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.