## Xalan-C++ API Documentation

### The Xalan C++ XSLT Processor Version 1.5

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

# XalanElement.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(XALANELEMENT_HEADER_GUARD_1357924680)
    00058 #define XALANELEMENT_HEADER_GUARD_1357924680
    00059
    00060
    00061
    00062 #include <XalanDOM/XalanDOMDefinitions.hpp>
    00063 #include <XalanDOM/XalanNode.hpp>
    00064
    00065
    00066
    00067 XALAN_CPP_NAMESPACE_BEGIN
    00068
    00069
    00070
    00071 class XalanAttr;
    00072
    00073
    00074
    00075 /*
    00076  * <meta name="usage" content="experimental"/>
    00077  *
    00078  * Base class for the DOM Element interface.
    00079  *
    00080  * This class is experimental and subject to change!!
    00081  */
    00082
    00083 class XALAN_DOM_EXPORT XalanElement : public XalanNode
    00084 {
    00085 public:
    00086
    00087     XalanElement();
    00088
    00089     virtual
    00090     ~XalanElement();
    00091
    00092     // These interfaces are inherited from XalanNode
    00093     virtual const XalanDOMString&
    00094     getNodeName() const = 0;
    00095
    00099     virtual const XalanDOMString&
    00100     getNodeValue() const = 0;
    00101
    00105     virtual NodeType
    00106     getNodeType() const = 0;
    00107
    00117     virtual XalanNode*
    00118     getParentNode() const = 0;
    00119
    00133     virtual const XalanNodeList*
    00134     getChildNodes() const = 0;
    00135
    00141     virtual XalanNode*
    00142     getFirstChild() const = 0;
    00143
    00149     virtual XalanNode*
    00150     getLastChild() const = 0;
    00151
    00157     virtual XalanNode*
    00158     getPreviousSibling() const = 0;
    00159
    00165     virtual XalanNode*
    00166     getNextSibling() const = 0;
    00167
    00172     virtual const XalanNamedNodeMap*
    00173     getAttributes() const = 0;
    00174
    00184     virtual XalanDocument*
    00185     getOwnerDocument() const = 0;
    00186
    00188
    00190
    00209 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
    00210     virtual XalanNode*
    00211 #else
    00212     virtual XalanElement*
    00213 #endif
    00214     cloneNode(bool  deep) const = 0;
    00215
    00217
    00219
    00236     virtual XalanNode*
    00237     insertBefore(
    00238             XalanNode*  newChild,
    00239             XalanNode*  refChild) = 0;
    00240
    00254     virtual XalanNode*
    00255     replaceChild(
    00256             XalanNode*  newChild,
    00257             XalanNode*  oldChild) = 0;
    00258
    00266     virtual XalanNode*
    00267     removeChild(XalanNode*  oldChild) = 0;
    00268
    00280     virtual XalanNode*
    00281     appendChild(XalanNode*  newChild) = 0;
    00282
    00284
    00286
    00294     virtual bool
    00295     hasChildNodes() const = 0;
    00296
    00297
    00299
    00301
    00302
    00316     virtual void
    00317     setNodeValue(const XalanDOMString&  nodeValue) = 0;
    00318
    00320
    00322
    00339     virtual void
    00340     normalize() = 0;
    00341
    00355     virtual bool
    00356     isSupported(
    00357             const XalanDOMString&   feature,
    00358             const XalanDOMString&   version) const = 0;
    00359
    00373     virtual const XalanDOMString&
    00374     getNamespaceURI() const = 0;
    00375
    00380     virtual const XalanDOMString&
    00381     getPrefix() const = 0;
    00382
    00390     virtual const XalanDOMString&
    00391     getLocalName() const = 0;
    00392
    00422     virtual void
    00423     setPrefix(const XalanDOMString& prefix) = 0;
    00424
    00430     virtual bool
    00431     isIndexed() const = 0;
    00432
    00439     virtual IndexType
    00440     getIndex() const = 0;
    00441
    00443
    00444     // These interfaces are new to XalanElement...
    00453     virtual const XalanDOMString&
    00454     getTagName() const = 0;
    00455
    00463     virtual const XalanDOMString&
    00464     getAttribute(const XalanDOMString&  name) const = 0;
    00465
    00473     virtual XalanAttr*
    00474     getAttributeNode(const XalanDOMString&  name) const = 0;
    00475
    00486     virtual XalanNodeList*
    00487     getElementsByTagName(const XalanDOMString&  name) const = 0;
    00488
    00490
    00492
    00514     virtual void
    00515     setAttribute(
    00516             const XalanDOMString&   name,
    00517             const XalanDOMString&   value) = 0;
    00518
    00538     virtual XalanAttr*
    00539     setAttributeNode(XalanAttr*     newAttr) = 0;
    00540
    00542
    00544
    00560     virtual XalanAttr*
    00561     removeAttributeNode(XalanAttr*  oldAttr) = 0;
    00562
    00575     virtual void
    00576     removeAttribute(const XalanDOMString&   name) = 0;
    00577
    00579
    00581
    00592     virtual const XalanDOMString&
    00593     getAttributeNS(
    00594             const XalanDOMString&   namespaceURI,
    00595             const XalanDOMString&   localName) const = 0;
    00596
    00637     virtual void
    00638     setAttributeNS(
    00639             const XalanDOMString&   namespaceURI,
    00640             const XalanDOMString&   qualifiedName,
    00641             const XalanDOMString&   value) = 0;
    00642
    00657     virtual void
    00658     removeAttributeNS(
    00659             const XalanDOMString&   namespaceURI,
    00660             const XalanDOMString&   localName) = 0;
    00661
    00672     virtual XalanAttr*
    00673     getAttributeNodeNS(
    00674             const XalanDOMString&   namespaceURI,
    00675             const XalanDOMString&   localName) const = 0;
    00676
    00696     virtual XalanAttr*
    00697     setAttributeNodeNS(XalanAttr*   newAttr) = 0;
    00698
    00714     virtual XalanNodeList*
    00715     getElementsByTagNameNS(
    00716             const XalanDOMString&   namespaceURI,
    00717             const XalanDOMString&   localName) const = 0;
    00718
    00720
    00721 protected:
    00722
    00723     XalanElement(const XalanElement&    theSource);
    00724
    00725     XalanElement&
    00726     operator=(const XalanElement&   theSource);
    00727
    00728     bool
    00729     operator==(const XalanElement&  theRHS) const;
    00730
    00731 private:
    00732 };
    00733
    00734
    00735
    00736 XALAN_CPP_NAMESPACE_END
    00737
    00738
    00739
    00740 #endif  // !defined(XALANELEMENT_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.5 Copyright © 2000, 2001, 2002, 2003 The Apache Software Foundation. All Rights Reserved.