DOMElement.hpp Source File

00001 #ifndef DOMElement_HEADER_GUARD_
00002 #define DOMElement_HEADER_GUARD_
00003 
00004 /*
00005  * The Apache Software License, Version 1.1
00006  *
00007  * Copyright (c) 2001-2002 The Apache Software Foundation.  All rights
00008  * reserved.
00009  *
00010  * Redistribution and use in source and binary forms, with or without
00011  * modification, are permitted provided that the following conditions
00012  * are met:
00013  *
00014  * 1. Redistributions of source code must retain the above copyright
00015  *    notice, this list of conditions and the following disclaimer.
00016  *
00017  * 2. Redistributions in binary form must reproduce the above copyright
00018  *    notice, this list of conditions and the following disclaimer in
00019  *    the documentation and/or other materials provided with the
00020  *    distribution.
00021  *
00022  * 3. The end-user documentation included with the redistribution,
00023  *    if any, must include the following acknowledgment:
00024  *       "This product includes software developed by the
00025  *        Apache Software Foundation (http://www.apache.org/)."
00026  *    Alternately, this acknowledgment may appear in the software itself,
00027  *    if and wherever such third-party acknowledgments normally appear.
00028  *
00029  * 4. The names "Xerces" and "Apache Software Foundation" must
00030  *    not be used to endorse or promote products derived from this
00031  *    software without prior written permission. For written
00032  *    permission, please contact apache\@apache.org.
00033  *
00034  * 5. Products derived from this software may not be called "Apache",
00035  *    nor may "Apache" appear in their name, without prior written
00036  *    permission of the Apache Software Foundation.
00037  *
00038  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00039  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00040  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00041  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00042  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00043  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00044  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00045  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00046  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00047  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00048  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00049  * SUCH DAMAGE.
00050  * ====================================================================
00051  *
00052  * This software consists of voluntary contributions made by many
00053  * individuals on behalf of the Apache Software Foundation, and was
00054  * originally based on software copyright (c) 2001, International
00055  * Business Machines, Inc., http://www.ibm.com .  For more information
00056  * on the Apache Software Foundation, please see
00057  * <http://www.apache.org/>.
00058  */
00059 
00060 /*
00061  * $Id: DOMElement.hpp,v 1.9 2003/03/07 19:59:03 tng Exp $
00062  */
00063 
00064 #include <xercesc/util/XercesDefs.hpp>
00065 #include "DOMNode.hpp"
00066 
00067 XERCES_CPP_NAMESPACE_BEGIN
00068 
00069 
00070 class DOMAttr;
00071 class DOMNodeList;
00072 class DOMTypeInfo;
00073 
00074 
00102 class  DOMElement: public DOMNode {
00103 protected:
00104     // -----------------------------------------------------------------------
00105     //  Hidden constructors
00106     // -----------------------------------------------------------------------
00109     DOMElement() {};
00111     
00112 private:
00113     // -----------------------------------------------------------------------
00114     // Unimplemented constructors and operators
00115     // -----------------------------------------------------------------------
00118     DOMElement(const DOMElement &);
00119     DOMElement & operator = (const DOMElement &);
00121 
00122 public:
00123     // -----------------------------------------------------------------------
00124     //  All constructors are hidden, just the destructor is available
00125     // -----------------------------------------------------------------------
00132     virtual ~DOMElement() {};
00134 
00135     // -----------------------------------------------------------------------
00136     //  Virtual DOMElement interface
00137     // -----------------------------------------------------------------------
00140     // -----------------------------------------------------------------------
00141     //  Getter methods
00142     // -----------------------------------------------------------------------
00152     virtual const XMLCh *         getTagName() const = 0;
00153 
00162     virtual const XMLCh *         getAttribute(const XMLCh *name) const = 0;
00163 
00172     virtual DOMAttr       * getAttributeNode(const XMLCh *name) const = 0;
00173 
00184     virtual DOMNodeList   * getElementsByTagName(const XMLCh *name) const = 0;
00185 
00186     // -----------------------------------------------------------------------
00187     //  Setter methods
00188     // -----------------------------------------------------------------------
00211     virtual void             setAttribute(const XMLCh *name,
00212                                   const XMLCh *value) = 0;
00233     virtual DOMAttr       * setAttributeNode(DOMAttr *newAttr) = 0;
00234 
00251     virtual DOMAttr       * removeAttributeNode(DOMAttr *oldAttr) = 0;
00252 
00266     virtual void              removeAttribute(const XMLCh *name) = 0;
00268 
00282     virtual const XMLCh *         getAttributeNS(const XMLCh *namespaceURI,
00283                                                  const XMLCh *localName) const = 0;
00284 
00324     virtual void             setAttributeNS(const XMLCh *namespaceURI,
00325                                             const XMLCh *qualifiedName, const XMLCh *value) = 0;
00326 
00341     virtual void              removeAttributeNS(const XMLCh *namespaceURI,
00342                                                 const XMLCh *localName) = 0;
00343 
00355     virtual DOMAttr      *  getAttributeNodeNS(const XMLCh *namespaceURI,
00356                                                const XMLCh *localName) const = 0;
00357 
00379     virtual DOMAttr      *  setAttributeNodeNS(DOMAttr *newAttr) = 0;
00380 
00396     virtual DOMNodeList   * getElementsByTagNameNS(const XMLCh *namespaceURI,
00397                                                    const XMLCh *localName) const = 0;
00398 
00409     virtual bool         hasAttribute(const XMLCh *name) const = 0;
00410 
00423     virtual bool         hasAttributeNS(const XMLCh *namespaceURI,
00424                                         const XMLCh *localName) const = 0;
00426 
00429 
00448     virtual void setIdAttribute(const XMLCh* name) = 0;
00449 
00450 
00468     virtual void setIdAttributeNS(const XMLCh* namespaceURI, const XMLCh* localName) = 0;
00469 
00470 
00471 
00487     virtual void setIdAttributeNode(const DOMAttr *idAttr) = 0;
00488 
00489 
00490 
00499     virtual const DOMTypeInfo* getTypeInfo() const = 0;
00500 
00502 
00503 };
00504 
00505 XERCES_CPP_NAMESPACE_END
00506 
00507 #endif
00508 
00509 
00510