Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.4

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

XalanSourceTreeAttr.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(XALANSOURCETREEATTR_HEADER_GUARD_1357924680)
00058 #define XALANSOURCETREEATTR_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 #include <XalanSourceTree/XalanSourceTreeDefinitions.hpp>
00063 
00064 
00065 
00066 #include <XalanDOM/XalanAttr.hpp>
00067 
00068 
00069 
00070 #include <XalanDOM/XalanDOMString.hpp>
00071 #include <XalanDOM/XalanNodeListDummy.hpp>
00072 
00073 
00074 
00075 class XalanSourceTreeDocument;
00076 class XalanSourceTreeElement;
00077 
00078 
00079 
00080 /*
00081  * <meta name="usage" content="experimental"/>
00082  *
00083  * Base class for the Xalan source tree Attr interface.
00084  *
00085  * This class is experimental and subject to change!!
00086  */
00087 
00088 class XALAN_XALANSOURCETREE_EXPORT XalanSourceTreeAttr : public XalanAttr
00089 {
00090 public:
00091 
00101     XalanSourceTreeAttr(
00102             const XalanDOMString&       theName,
00103             const XalanDOMString&       theValue,
00104             XalanSourceTreeElement*     theOwnerElement = 0,
00105             unsigned int                theIndex = 0);
00106 
00107     virtual
00108     ~XalanSourceTreeAttr();
00109 
00110 
00111     // These interfaces are inherited from XalanNode...
00112     virtual const XalanDOMString&
00113     getNodeName() const;
00114 
00118     virtual const XalanDOMString&
00119     getNodeValue() const;
00120 
00124     virtual NodeType
00125     getNodeType() const;
00126 
00136     virtual XalanNode*
00137     getParentNode() const;
00138 
00152     virtual const XalanNodeList*
00153     getChildNodes() const;
00154 
00160     virtual XalanNode*
00161     getFirstChild() const;
00162 
00168     virtual XalanNode*
00169     getLastChild() const;
00170 
00176     virtual XalanNode*
00177     getPreviousSibling() const;
00178 
00184     virtual XalanNode*
00185     getNextSibling() const;
00186 
00191     virtual const XalanNamedNodeMap*
00192     getAttributes() const;
00193 
00203     virtual XalanDocument*
00204     getOwnerDocument() const;
00205 
00206     //@}
00208     //@{
00209 
00228 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00229     virtual XalanNode*
00230 #else
00231     virtual XalanSourceTreeAttr*
00232 #endif
00233     cloneNode(bool deep) const;
00234 
00235     //@}
00237     //@{
00238 
00255     virtual XalanNode*
00256     insertBefore(
00257             XalanNode*  newChild,
00258             XalanNode*  refChild);
00259 
00273     virtual XalanNode*
00274     replaceChild(
00275             XalanNode*  newChild,
00276             XalanNode*  oldChild);
00277 
00285     virtual XalanNode*
00286     removeChild(XalanNode*  oldChild);
00287 
00299     virtual XalanNode*
00300     appendChild(XalanNode*  newChild);
00301 
00302     //@}
00304     //@{
00305 
00313     virtual bool
00314     hasChildNodes() const;
00315 
00316 
00317     //@}
00319     //@{
00320 
00321 
00335     virtual void
00336     setNodeValue(const XalanDOMString&  nodeValue);
00337 
00338     //@}
00340     //@{
00341 
00358     virtual void
00359     normalize();
00360 
00374     virtual bool
00375     isSupported(
00376             const XalanDOMString&   feature,
00377             const XalanDOMString&   version) const;
00378 
00392     virtual const XalanDOMString&
00393     getNamespaceURI() const;
00394 
00399     virtual const XalanDOMString&
00400     getPrefix() const;
00401 
00409     virtual const XalanDOMString&
00410     getLocalName() const;
00411 
00441     virtual void
00442     setPrefix(const XalanDOMString&     prefix);
00443 
00449     virtual bool
00450     isIndexed() const;
00451 
00458     virtual unsigned long
00459     getIndex() const;
00460 
00461     //@}
00462 
00463     // These interfaces are inherited from XalanAttr...
00464 
00466      //@{
00471     virtual const XalanDOMString&
00472     getName() const;
00473 
00481     virtual bool
00482     getSpecified() const;
00483 
00490     virtual const XalanDOMString&
00491     getValue() const;
00492 
00493     //@}
00495     //@{
00496     
00503     virtual void
00504     setValue(const XalanDOMString&  value);
00505 
00506     //@}
00507 
00509     //@{
00514     virtual XalanElement*
00515     getOwnerElement() const;
00516     //@}
00517 
00518 
00519     // public interfaces not inherited from XalanAttr...
00520 
00521     void
00522     setOwnerElement(XalanSourceTreeElement*     theElement)
00523     {
00524         m_ownerElement = theElement;
00525     }
00526 
00527     void
00528     setIndex(unsigned int   theIndex)
00529     {
00530         m_index = theIndex;
00531     }
00532 
00533 protected:
00534 
00535     XalanSourceTreeAttr(
00536             const XalanSourceTreeAttr&  theSource,
00537             bool                        deep = false);
00538 
00539 private:
00540 
00541     // Not defined...
00542     XalanSourceTreeAttr&
00543     operator=(const XalanSourceTreeAttr&    theSource);
00544 
00545     bool
00546     operator==(const XalanSourceTreeAttr&   theRHS) const;
00547 
00548 
00549     // Data members...
00550     const XalanDOMString&               m_name;
00551 
00552     const XalanDOMString&               m_value;
00553 
00554     XalanSourceTreeElement*             m_ownerElement;
00555 
00556     unsigned int                        m_index;
00557 };
00558 
00559 
00560 
00561 #endif  // !defined(XALANSOURCETREEATTR_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.4
Copyright © 2000, 2001, 2002 The Apache Software Foundation. All Rights Reserved.