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  

XalanElement.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999 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 class XalanAttr;
00068 
00069 
00070 
00071 /*
00072  * <meta name="usage" content="experimental"/>
00073  *
00074  * Base class for the DOM Element interface.
00075  *
00076  * This class is experimental and subject to change!!
00077  */
00078 
00079 class XALAN_DOM_EXPORT XalanElement : public XalanNode
00080 {
00081 public:
00082 
00083     XalanElement();
00084 
00085     virtual
00086     ~XalanElement();
00087 
00088     // These interfaces are inherited from XalanNode
00089     virtual const XalanDOMString&
00090     getNodeName() const = 0;
00091 
00095     virtual const XalanDOMString&
00096     getNodeValue() const = 0;
00097 
00101     virtual NodeType
00102     getNodeType() const = 0;
00103 
00113     virtual XalanNode*
00114     getParentNode() const = 0;
00115 
00129     virtual const XalanNodeList*
00130     getChildNodes() const = 0;
00131 
00137     virtual XalanNode*
00138     getFirstChild() const = 0;
00139 
00145     virtual XalanNode*
00146     getLastChild() const = 0;
00147 
00153     virtual XalanNode*
00154     getPreviousSibling() const = 0;
00155 
00161     virtual XalanNode*
00162     getNextSibling() const = 0;
00163 
00168     virtual const XalanNamedNodeMap*
00169     getAttributes() const = 0;
00170 
00180     virtual XalanDocument*
00181     getOwnerDocument() const = 0;
00182 
00184 
00186 
00205 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00206     virtual XalanNode*
00207 #else
00208     virtual XalanElement*
00209 #endif
00210     cloneNode(bool  deep) const = 0;
00211 
00213 
00215 
00232     virtual XalanNode*
00233     insertBefore(
00234             XalanNode*  newChild,
00235             XalanNode*  refChild) = 0;
00236 
00250     virtual XalanNode*
00251     replaceChild(
00252             XalanNode*  newChild,
00253             XalanNode*  oldChild) = 0;
00254 
00262     virtual XalanNode*
00263     removeChild(XalanNode*  oldChild) = 0;
00264 
00276     virtual XalanNode*
00277     appendChild(XalanNode*  newChild) = 0;
00278 
00280 
00282 
00290     virtual bool
00291     hasChildNodes() const = 0;
00292 
00293 
00295 
00297 
00298 
00312     virtual void
00313     setNodeValue(const XalanDOMString&  nodeValue) = 0;
00314 
00316 
00318 
00335     virtual void
00336     normalize() = 0;
00337 
00351     virtual bool
00352     supports(
00353             const XalanDOMString&   feature,
00354             const XalanDOMString&   version) const = 0;
00355 
00369     virtual const XalanDOMString&
00370     getNamespaceURI() const = 0;
00371 
00376     virtual const XalanDOMString&
00377     getPrefix() const = 0;
00378 
00386     virtual const XalanDOMString&
00387     getLocalName() const = 0;
00388 
00418     virtual void
00419     setPrefix(const XalanDOMString& prefix) = 0;
00420 
00426     virtual bool
00427     isIndexed() const = 0;
00428 
00435     virtual unsigned long
00436     getIndex() const = 0;
00437 
00439 
00440     // These interfaces are new to XalanElement...
00449     virtual const XalanDOMString&
00450     getTagName() const = 0;
00451 
00459     virtual const XalanDOMString&
00460     getAttribute(const XalanDOMString&  name) const = 0;
00461 
00469     virtual XalanAttr*
00470     getAttributeNode(const XalanDOMString&  name) const = 0;
00471 
00482     virtual XalanNodeList*
00483     getElementsByTagName(const XalanDOMString&  name) const = 0;
00484 
00486 
00488 
00510     virtual void
00511     setAttribute(
00512             const XalanDOMString&   name, 
00513             const XalanDOMString&   value) = 0;
00514 
00534     virtual XalanAttr*
00535     setAttributeNode(XalanAttr*     newAttr) = 0;
00536 
00538 
00540     
00556     virtual XalanAttr*
00557     removeAttributeNode(XalanAttr*  oldAttr) = 0;
00558 
00571     virtual void
00572     removeAttribute(const XalanDOMString&   name) = 0;
00573 
00575 
00577 
00588     virtual const XalanDOMString&
00589     getAttributeNS(
00590             const XalanDOMString&   namespaceURI,
00591             const XalanDOMString&   localName) const = 0;
00592 
00633     virtual void
00634     setAttributeNS(
00635             const XalanDOMString&   namespaceURI,
00636             const XalanDOMString&   qualifiedName,
00637             const XalanDOMString&   value) = 0;
00638 
00653     virtual void
00654     removeAttributeNS(
00655             const XalanDOMString&   namespaceURI,
00656             const XalanDOMString&   localName) = 0;
00657 
00668     virtual XalanAttr*
00669     getAttributeNodeNS(
00670             const XalanDOMString&   namespaceURI,
00671             const XalanDOMString&   localName) const = 0;
00672 
00692     virtual XalanAttr*
00693     setAttributeNodeNS(XalanAttr*   newAttr) = 0;
00694 
00710     virtual XalanNodeList*
00711     getElementsByTagNameNS(
00712             const XalanDOMString&   namespaceURI,
00713             const XalanDOMString&   localName) const = 0;
00714 
00716 
00717 protected:
00718 
00719     XalanElement(const XalanElement&    theSource);
00720 
00721     XalanElement&
00722     operator=(const XalanElement&   theSource);
00723 
00724     bool
00725     operator==(const XalanElement&  theRHS) const;
00726 
00727 private:
00728 };
00729 
00730 
00731 
00732 #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++ XSL Transformer Version 1.1
Copyright © 2000, 2001 The Apache Software Foundation. All Rights Reserved.