Xalan-C++ API Documentation

The Xalan C++ XSL Transformer Version 1.1

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

ResultTreeFrag.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(RESULTTREEFRAG_HEADER_GUARD_1357924680)
00058 #define RESULTTREEFRAG_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 // Base include file.  Must be first.
00063 #include <XPath/XPathDefinitions.hpp>
00064 
00065 
00066 
00067 #include <vector>
00068 
00069 
00070 
00071 #include <XalanDOM/XalanNodeList.hpp>
00072 #include <XalanDOM/XalanDocument.hpp>
00073 
00074 
00075 
00076 #include <XPath/ResultTreeFragBase.hpp>
00077 
00078 
00079 
00083 class XALAN_XPATH_EXPORT ResultTreeFrag : public ResultTreeFragBase, private XalanNodeList
00084 {
00085 public:
00086 
00092     ResultTreeFrag(XalanDocument*   theOwnerDocument = 0);
00093 
00100     ResultTreeFrag(const ResultTreeFrag&    theSource,
00101                    bool                     deepClone = false);
00102 
00103     virtual
00104     ~ResultTreeFrag();
00105 
00106 
00107     // These interfaces are inherited from ResultTreeFragBase...
00108 
00109     virtual void
00110     clear();
00111 
00112     virtual void
00113     setOwnerDocument(XalanDocument*     theOwnerDocument);
00114 
00115 
00116     // These interfaces are inherited from XalanDocumentFragment...
00117 
00118     virtual const XalanDOMString&
00119     getNodeName() const;
00120 
00121     virtual const XalanDOMString&
00122     getNodeValue() const;
00123 
00124     virtual NodeType
00125     getNodeType() const;
00126 
00127     virtual XalanNode*
00128     getParentNode() const;
00129 
00130     virtual const XalanNodeList*
00131     getChildNodes() const;
00132 
00133     virtual XalanNode*
00134     getFirstChild() const;
00135 
00136     virtual XalanNode*
00137     getLastChild() const;
00138 
00139     virtual XalanNode*
00140     getPreviousSibling() const;
00141 
00142     virtual XalanNode*
00143     getNextSibling() const;
00144 
00145     virtual const XalanNamedNodeMap*
00146     getAttributes() const;
00147 
00148     virtual XalanDocument*
00149     getOwnerDocument() const;
00150 
00151 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00152     virtual XalanNode*
00153 #else
00154     virtual ResultTreeFrag*
00155 #endif
00156     cloneNode(bool deep) const;
00157 
00158     virtual XalanNode*
00159     insertBefore(
00160             XalanNode*  newChild,
00161             XalanNode*  refChild);
00162 
00163     virtual XalanNode*
00164     replaceChild(
00165             XalanNode*  newChild,
00166             XalanNode*  oldChild);
00167 
00168     virtual XalanNode*
00169     removeChild(XalanNode*  oldChild);
00170 
00171     virtual XalanNode*
00172     appendChild(XalanNode*  newChild);
00173 
00174     virtual bool
00175     hasChildNodes() const;
00176 
00177     virtual void
00178     setNodeValue(const XalanDOMString&  nodeValue);
00179 
00180     virtual void
00181     normalize();
00182 
00183     virtual bool
00184     supports(
00185             const XalanDOMString&   feature,
00186             const XalanDOMString&   version) const;
00187 
00188     virtual const XalanDOMString&
00189     getNamespaceURI() const;
00190 
00191     virtual const XalanDOMString&
00192     getPrefix() const;
00193 
00194     virtual const XalanDOMString&
00195     getLocalName() const;
00196 
00197     virtual void
00198     setPrefix(const XalanDOMString&     prefix);
00199 
00200     virtual bool
00201     isIndexed() const;
00202 
00203     virtual unsigned long
00204     getIndex() const;
00205 
00206 #if defined(XALAN_NO_COVARIANT_RETURN_TYPE)
00207     virtual ResultTreeFragBase*
00208 #else
00209     virtual ResultTreeFrag*
00210 #endif
00211     clone(bool  deep) const;
00212 
00213 private:
00214 
00215     // These methods are inherited from XalanNodeList...
00216 
00217     virtual XalanNode*
00218     item(unsigned int   index) const;
00219 
00220     virtual unsigned int
00221     getLength() const;
00222 
00223     // Not defined
00224     ResultTreeFrag&
00225     operator=(const ResultTreeFrag&     theRHS);
00226 
00227     bool
00228     operator==(const ResultTreeFrag&    theRHS) const;
00229 
00230 
00231     XalanDocument*                  m_document;
00232 
00233 #if defined(XALAN_NO_NAMESPACES)
00234     typedef vector<XalanNode*>          NodeVectorType;
00235 #else
00236     typedef std::vector<XalanNode*>     NodeVectorType;
00237 #endif
00238 
00239     NodeVectorType                  m_children;
00240 
00241     static const XalanDOMString     s_emptyString;
00242 };
00243 
00244 
00245 
00246 #endif  // RESULTTREEFRAGBASE_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.1
Copyright © 2000, 2001 The Apache Software Foundation. All Rights Reserved.