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  

XalanSourceTreeAttr.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(XALANSOURCETREEATTR_HEADER_GUARD_1357924680)
00058 #define XALANSOURCETREEATTR_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 #include <xalanc/XalanSourceTree/XalanSourceTreeDefinitions.hpp>
00063 
00064 
00065 
00066 #include <xalanc/XalanDOM/XalanAttr.hpp>
00067 
00068 
00069 
00070 #include <xalanc/XalanDOM/XalanDOMString.hpp>
00071 
00072 
00073 
00074 XALAN_CPP_NAMESPACE_BEGIN
00075 
00076 
00077 
00078 class XalanSourceTreeDocument;
00079 class XalanSourceTreeElement;
00080 
00081 
00082 
00083 /*
00084  * <meta name="usage" content="experimental"/>
00085  *
00086  * Base class for the Xalan source tree Attr interface.
00087  *
00088  * This class is experimental and subject to change!!
00089  */
00090 
00091 class XALAN_XALANSOURCETREE_EXPORT XalanSourceTreeAttr : public XalanAttr
00092 {
00093 public:
00094 
00104     XalanSourceTreeAttr(
00105             const XalanDOMString&       theName,
00106             const XalanDOMString&       theValue,
00107             XalanSourceTreeElement*     theOwnerElement = 0,
00108             IndexType                   theIndex = 0);
00109 
00110     virtual
00111     ~XalanSourceTreeAttr();
00112 
00113 
00114     // These interfaces are inherited from XalanNode...
00115     virtual const XalanDOMString&
00116     getNodeName() const;
00117 
00121     virtual const XalanDOMString&
00122     getNodeValue() const;
00123 
00127     virtual NodeType
00128     getNodeType() const;
00129 
00139     virtual XalanNode*
00140     getParentNode() const;
00141 
00155     virtual const XalanNodeList*
00156     getChildNodes() const;
00157 
00163     virtual XalanNode*
00164     getFirstChild() const;
00165 
00171     virtual XalanNode*
00172     getLastChild() const;
00173 
00179     virtual XalanNode*
00180     getPreviousSibling() const;
00181 
00187     virtual XalanNode*
00188     getNextSibling() const;
00189 
00194     virtual const XalanNamedNodeMap*
00195     getAttributes() const;
00196 
00206     virtual XalanDocument*
00207     getOwnerDocument() const;
00208 
00210 
00212 
00231 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00232     virtual XalanNode*
00233 #else
00234     virtual XalanSourceTreeAttr*
00235 #endif
00236     cloneNode(bool deep) const;
00237 
00239 
00241 
00258     virtual XalanNode*
00259     insertBefore(
00260             XalanNode*  newChild,
00261             XalanNode*  refChild);
00262 
00276     virtual XalanNode*
00277     replaceChild(
00278             XalanNode*  newChild,
00279             XalanNode*  oldChild);
00280 
00288     virtual XalanNode*
00289     removeChild(XalanNode*  oldChild);
00290 
00302     virtual XalanNode*
00303     appendChild(XalanNode*  newChild);
00304 
00306 
00308 
00316     virtual bool
00317     hasChildNodes() const;
00318 
00319 
00321 
00323 
00324 
00338     virtual void
00339     setNodeValue(const XalanDOMString&  nodeValue);
00340 
00342 
00344 
00361     virtual void
00362     normalize();
00363 
00377     virtual bool
00378     isSupported(
00379             const XalanDOMString&   feature,
00380             const XalanDOMString&   version) const;
00381 
00395     virtual const XalanDOMString&
00396     getNamespaceURI() const;
00397 
00402     virtual const XalanDOMString&
00403     getPrefix() const;
00404 
00412     virtual const XalanDOMString&
00413     getLocalName() const;
00414 
00444     virtual void
00445     setPrefix(const XalanDOMString&     prefix);
00446 
00452     virtual bool
00453     isIndexed() const;
00454 
00461     virtual IndexType
00462     getIndex() const;
00463 
00465 
00466     // These interfaces are inherited from XalanAttr...
00467 
00470 
00474     virtual const XalanDOMString&
00475     getName() const;
00476 
00484     virtual bool
00485     getSpecified() const;
00486 
00493     virtual const XalanDOMString&
00494     getValue() const;
00495 
00497 
00499     
00506     virtual void
00507     setValue(const XalanDOMString&  value);
00508 
00510 
00513 
00517     virtual XalanElement*
00518     getOwnerElement() const;
00520 
00521 
00522     // public interfaces not inherited from XalanAttr...
00523 
00524     void
00525     setOwnerElement(XalanSourceTreeElement*     theElement)
00526     {
00527         m_ownerElement = theElement;
00528     }
00529 
00530     void
00531     setIndex(IndexType  theIndex)
00532     {
00533         m_index = theIndex;
00534     }
00535 
00536 protected:
00537 
00538     XalanSourceTreeAttr(
00539             const XalanSourceTreeAttr&  theSource,
00540             bool                        deep = false);
00541 
00542 private:
00543 
00544     // Not defined...
00545     XalanSourceTreeAttr&
00546 	operator=(const XalanSourceTreeAttr&   theSource);
00547 
00548     bool
00549 	operator==(const XalanSourceTreeAttr&  theRHS) const;
00550 
00551 
00552     // Data members...
00553     const XalanDOMString&       m_name;
00554 
00555     const XalanDOMString&       m_value;
00556 
00557     XalanSourceTreeElement*     m_ownerElement;
00558 
00559     IndexType                   m_index;
00560 };
00561 
00562 
00563 
00564 XALAN_CPP_NAMESPACE_END
00565 
00566 
00567 
00568 #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.6
Copyright © 2000, 2001, 2002, 2003 The Apache Software Foundation. All Rights Reserved.