Xalan-C++ API Documentation

The Xalan-C++ XSL Transformer Version 1.0

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

XalanNode.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(XALANNODE_HEADER_GUARD_1357924680)
00058 #define XALANNODE_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 #include <XalanDOM/XalanDOMDefinitions.hpp>
00063 #include <XalanDOM/XalanDOMString.hpp>
00064 
00065 
00066 
00067 class XalanDocument;
00068 class XalanNamedNodeMap;
00069 class XalanNodeList;
00070 
00071 
00072 
00073 /*
00074  * <meta name="usage" content="experimental"/>
00075  *
00076  * Base class for the DOM Node interface.
00077  *
00078  * This class is experimental and subject to change!!
00079  */
00080 
00081 class XALAN_DOM_EXPORT XalanNode
00082 {
00083 public:
00084 
00085     XalanNode();
00086 
00087     virtual
00088     ~XalanNode();
00089 
00090     enum NodeType
00091     {
00092         UNKNOWN_NODE                = 0,
00093         ELEMENT_NODE                = 1,
00094         ATTRIBUTE_NODE              = 2,
00095         TEXT_NODE                   = 3,
00096         CDATA_SECTION_NODE          = 4,
00097         ENTITY_REFERENCE_NODE       = 5,
00098         ENTITY_NODE                 = 6,
00099         PROCESSING_INSTRUCTION_NODE = 7,
00100         COMMENT_NODE                = 8,
00101         DOCUMENT_NODE               = 9,
00102         DOCUMENT_TYPE_NODE          = 10,
00103         DOCUMENT_FRAGMENT_NODE      = 11,
00104         NOTATION_NODE               = 12
00105     };
00106 
00107     virtual XalanDOMString
00108     getNodeName() const = 0;
00109 
00113     virtual XalanDOMString
00114     getNodeValue() const = 0;
00115 
00119     virtual NodeType
00120     getNodeType() const = 0;
00121 
00131     virtual XalanNode*
00132     getParentNode() const = 0;
00133 
00147     virtual const XalanNodeList*
00148     getChildNodes() const = 0;
00149 
00155     virtual XalanNode*
00156     getFirstChild() const = 0;
00157 
00163     virtual XalanNode*
00164     getLastChild() const = 0;
00165 
00171     virtual XalanNode*
00172     getPreviousSibling() const = 0;
00173 
00179     virtual XalanNode*
00180     getNextSibling() const = 0;
00181 
00186     virtual const XalanNamedNodeMap*
00187     getAttributes() const = 0;
00188 
00198     virtual XalanDocument*
00199     getOwnerDocument() const = 0;
00200 
00201     //@}
00203     //@{
00204 
00223     virtual XalanNode*
00224     cloneNode(bool deep) const = 0;
00225 
00226     //@}
00228     //@{
00229 
00246     virtual XalanNode*
00247     insertBefore(
00248             XalanNode*  newChild,
00249             XalanNode*  refChild) = 0;
00250 
00264     virtual XalanNode*
00265     replaceChild(
00266             XalanNode*  newChild,
00267             XalanNode*  oldChild) = 0;
00268 
00276     virtual XalanNode*
00277     removeChild(XalanNode*  oldChild) = 0;
00278 
00290     virtual XalanNode*
00291     appendChild(XalanNode*  newChild) = 0;
00292 
00293     //@}
00295     //@{
00296 
00304     virtual bool
00305     hasChildNodes() const = 0;
00306 
00307 
00308     //@}
00310     //@{
00311 
00312 
00326     virtual void
00327     setNodeValue(const XalanDOMString&      nodeValue) = 0;
00328 
00329     //@}
00331     //@{
00332 
00349     virtual void
00350     normalize() = 0;
00351 
00365     virtual bool
00366     supports(
00367             const XalanDOMString&   feature,
00368             const XalanDOMString&   version) const = 0;
00369 
00383     virtual XalanDOMString
00384     getNamespaceURI() const = 0;
00385 
00390     virtual XalanDOMString
00391     getPrefix() const = 0;
00392 
00400     virtual XalanDOMString
00401     getLocalName() const = 0;
00402 
00432     virtual void
00433     setPrefix(const XalanDOMString& prefix) = 0;
00434 
00440     virtual bool
00441     isIndexed() const = 0;
00442 
00449     virtual unsigned long
00450     getIndex() const = 0;
00451 
00458     virtual XalanDOMString
00459     getXSLTData() const = 0;
00460 
00461     //@}
00462 
00463 
00464 #if !defined(NDEBUG)
00465 
00470     static unsigned long
00471     getInstanceCount()
00472     {
00473         return s_instanceCount;
00474     }
00475 
00476 
00486     static void
00487     getLiveInstances(XalanNode* theNodes[]);
00488 
00489 #endif
00490 
00491 protected:
00492 
00493     XalanNode(const XalanNode&  theSource);
00494 
00495     XalanNode&
00496     operator=(const XalanNode&  theSource);
00497 
00498     bool
00499     operator==(const XalanNode&     theRHS) const;
00500 
00501 private:
00502 
00503 #if !defined(NDEBUG)
00504     static unsigned long    s_instanceCount;
00505 #endif
00506 };
00507 
00508 
00509 
00510 #endif  // !defined(XALANNODE_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.0
Copyright © 2000 The Apache Software Foundation. All Rights Reserved.