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  

MutableNodeRefList.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(MUTABLENODEREFLIST_HEADER_GUARD_1357924680)
00058 #define MUTABLENODEREFLIST_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 // Base include file.  Must be first.
00063 #include <XPath/XPathDefinitions.hpp>
00064 
00065 
00066 
00067 #include <XPath/NodeRefList.hpp>
00068 
00069 
00070 
00071 class XPathExecutionContext;
00072 class XalanDocument;
00073 class XalanNodeList;
00074 
00075 
00076 
00081 class XALAN_XPATH_EXPORT MutableNodeRefList : public NodeRefList
00082 {
00083 public:
00084 
00088     explicit
00089     MutableNodeRefList();
00090 
00096     MutableNodeRefList(const MutableNodeRefList&    theSource);
00097 
00103     explicit
00104     MutableNodeRefList(const NodeRefListBase&   theSource);
00105 
00106     virtual
00107     ~MutableNodeRefList();
00108 
00109     MutableNodeRefList&
00110     operator=(const MutableNodeRefList&     theRHS);
00111 
00112     MutableNodeRefList&
00113     operator=(const NodeRefList&        theRHS);
00114 
00115     MutableNodeRefList&
00116     operator=(const NodeRefListBase&    theRHS);
00117 
00118     MutableNodeRefList&
00119     operator=(const XalanNodeList*  theRHS);
00120 
00126     void
00127     addNode(XalanNode*  n);
00128 
00135     void
00136     insertNode(
00137             XalanNode*      n,
00138             unsigned int    pos);
00139 
00145     void
00146     removeNode(const XalanNode*     n);
00147 
00153     void
00154     removeNode(unsigned int     pos);
00155 
00159     void
00160     clear();
00161 
00168     void
00169     setNode(unsigned int    pos,
00170             XalanNode*      n = 0);
00171 
00178     void
00179     addNodes(const XalanNodeList&   nodelist);
00180 
00187     void
00188     addNodes(const NodeRefListBase&     nodelist);
00189 
00196     void
00197     addNodesInDocOrder(
00198             const XalanNodeList&    nodelist,
00199             XPathExecutionContext&  executionContext);
00200   
00207     void
00208     addNodesInDocOrder(
00209             const NodeRefListBase&  nodelist,
00210             XPathExecutionContext&  executionContext);
00211 
00218     void
00219     addNodesInDocOrder(
00220             const MutableNodeRefList&   nodelist,
00221             XPathExecutionContext&      executionContext);
00222   
00229     void
00230     addNodeInDocOrder(
00231             XalanNode*              node,
00232             XPathExecutionContext&  executionContext);
00233 
00237     void
00238     clearNulls();
00239 
00243     void
00244     reverse();
00245 
00260     void
00261     reserve(unsigned int    theCount)
00262     {
00263         m_nodeList.reserve(theCount);
00264     }
00265 
00271     void
00272     setDocumentOrder()
00273     {
00274         m_order = eDocumentOrder;
00275     }
00276 
00282     void
00283     setReverseDocumentOrder()
00284     {
00285         m_order = eReverseDocumentOrder;
00286     }
00287 
00288     typedef NodeListVectorType::iterator    NodeListIteratorType;
00289 
00290     class addNodeInDocOrderFunctor
00291     {
00292     public:
00293 
00294         addNodeInDocOrderFunctor(
00295                 MutableNodeRefList&     theList,
00296                 XPathExecutionContext&  theExecutionContext) :
00297             m_list(theList),
00298             m_executionContext(theExecutionContext)
00299         {
00300         }
00301 
00302         void
00303         operator()(XalanNode*   theNode) const
00304         {
00305             m_list.addNodeInDocOrder(theNode, m_executionContext);
00306         }
00307 
00308     private:
00309 
00310         MutableNodeRefList&     m_list;
00311 
00312         XPathExecutionContext&  m_executionContext;
00313     };
00314 
00315 private:
00316 
00317     // An enum to determine what the order of the nodes is...
00318     enum eOrder { eUnknownOrder, eDocumentOrder, eReverseDocumentOrder };
00319 
00320     eOrder  m_order;
00321 };
00322 
00323 
00324 
00325 #endif  // MUTABLENODEREFLIST_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.