Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.6

Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

XalanNode.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(XALANNODE_HEADER_GUARD_1357924680)
00058 #define XALANNODE_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 #include <xalanc/XalanDOM/XalanDOMDefinitions.hpp>
00063 
00064 
00065 
00066 XALAN_CPP_NAMESPACE_BEGIN
00067 
00068 
00069 
00070 class XalanDOMString;
00071 class XalanDocument;
00072 class XalanNamedNodeMap;
00073 class XalanNodeList;
00074 
00075 
00076 
00077 /*
00078  * <meta name="usage" content="experimental"/>
00079  *
00080  * Base class for the DOM Node interface.
00081  *
00082  * This class is experimental and subject to change!!
00083  */
00084 
00085 class XALAN_DOM_EXPORT XalanNode
00086 {
00087 public:
00088 
00089     XalanNode();
00090 
00091     virtual
00092     ~XalanNode();
00093 
00094     enum NodeType
00095     {
00096         UNKNOWN_NODE                = 0,
00097         ELEMENT_NODE                = 1,
00098         ATTRIBUTE_NODE              = 2,
00099         TEXT_NODE                   = 3,
00100         CDATA_SECTION_NODE          = 4,
00101         ENTITY_REFERENCE_NODE       = 5,
00102         ENTITY_NODE                 = 6,
00103         PROCESSING_INSTRUCTION_NODE = 7,
00104         COMMENT_NODE                = 8,
00105         DOCUMENT_NODE               = 9,
00106         DOCUMENT_TYPE_NODE          = 10,
00107         DOCUMENT_FRAGMENT_NODE      = 11,
00108         NOTATION_NODE               = 12
00109     };
00110 
00111     typedef unsigned long   IndexType;
00112 
00113     virtual const XalanDOMString&
00114     getNodeName() const = 0;
00115 
00119     virtual const XalanDOMString&
00120     getNodeValue() const = 0;
00121 
00125     virtual NodeType
00126     getNodeType() const = 0;
00127 
00137     virtual XalanNode*
00138     getParentNode() const = 0;
00139 
00153     virtual const XalanNodeList*
00154     getChildNodes() const = 0;
00155 
00161     virtual XalanNode*
00162     getFirstChild() const = 0;
00163 
00169     virtual XalanNode*
00170     getLastChild() const = 0;
00171 
00177     virtual XalanNode*
00178     getPreviousSibling() const = 0;
00179 
00185     virtual XalanNode*
00186     getNextSibling() const = 0;
00187 
00192     virtual const XalanNamedNodeMap*
00193     getAttributes() const = 0;
00194 
00204     virtual XalanDocument*
00205     getOwnerDocument() const = 0;
00206 
00208 
00210 
00229     virtual XalanNode*
00230     cloneNode(bool deep) const = 0;
00231 
00233 
00235 
00252     virtual XalanNode*
00253     insertBefore(
00254             XalanNode*  newChild,
00255             XalanNode*  refChild) = 0;
00256 
00270     virtual XalanNode*
00271     replaceChild(
00272             XalanNode*  newChild,
00273             XalanNode*  oldChild) = 0;
00274 
00282     virtual XalanNode*
00283     removeChild(XalanNode*  oldChild) = 0;
00284 
00296     virtual XalanNode*
00297     appendChild(XalanNode*  newChild) = 0;
00298 
00300 
00302 
00310     virtual bool
00311     hasChildNodes() const = 0;
00312 
00313 
00315 
00317 
00318 
00332     virtual void
00333     setNodeValue(const XalanDOMString&      nodeValue) = 0;
00334 
00336 
00338 
00355     virtual void
00356     normalize() = 0;
00357 
00371     virtual bool
00372     isSupported(
00373             const XalanDOMString&   feature,
00374             const XalanDOMString&   version) const = 0;
00375 
00389     virtual const XalanDOMString&
00390     getNamespaceURI() const = 0;
00391 
00396     virtual const XalanDOMString&
00397     getPrefix() const = 0;
00398 
00406     virtual const XalanDOMString&
00407     getLocalName() const = 0;
00408 
00438     virtual void
00439     setPrefix(const XalanDOMString& prefix) = 0;
00440 
00446     virtual bool
00447     isIndexed() const = 0;
00448 
00455     virtual IndexType
00456     getIndex() const = 0;
00457 
00459 
00460 protected:
00461 
00462     XalanNode(const XalanNode&  theSource);
00463 
00464     XalanNode&
00465     operator=(const XalanNode&  theSource);
00466 
00467     bool
00468     operator==(const XalanNode&     theRHS) const;
00469 
00470 private:
00471 
00472 #if !defined(NDEBUG)
00473     static size_t   s_instanceCount;
00474 #endif
00475 };
00476 
00477 
00478 
00479 XALAN_CPP_NAMESPACE_END
00480 
00481 
00482 
00483 #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++ XSLT Processor Version 1.6
Copyright © 2000, 2001, 2002, 2003 The Apache Software Foundation. All Rights Reserved.