Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.4

Main Page   Namespace List   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-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(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             size_type   pos);
00139 
00145     void
00146     removeNode(const XalanNode*     n);
00147 
00153     void
00154     removeNode(size_type    pos);
00155 
00159     void
00160     clear();
00161 
00168     void
00169     setNode(
00170             size_type   pos,
00171             XalanNode*  n = 0);
00172 
00179     void
00180     addNodes(const XalanNodeList&   nodelist);
00181 
00188     void
00189     addNodes(const NodeRefListBase&     nodelist);
00190 
00197     void
00198     addNodesInDocOrder(
00199             const XalanNodeList&    nodelist,
00200             XPathExecutionContext&  executionContext);
00201   
00208     void
00209     addNodesInDocOrder(
00210             const NodeRefListBase&  nodelist,
00211             XPathExecutionContext&  executionContext);
00212 
00219     void
00220     addNodesInDocOrder(
00221             const MutableNodeRefList&   nodelist,
00222             XPathExecutionContext&      executionContext);
00223   
00230     void
00231     addNodeInDocOrder(
00232             XalanNode*              node,
00233             XPathExecutionContext&  executionContext);
00234 
00238     void
00239     clearNulls();
00240 
00244     void
00245     reverse();
00246 
00252     void
00253     reverseAssign(MutableNodeRefList&   nodelist) const;
00254 
00269     void
00270     reserve(size_type   theCount)
00271     {
00272         m_nodeList.reserve(theCount);
00273     }
00274 
00278     bool
00279     getUnknownOrder() const
00280     {
00281         return m_order == eUnknownOrder ? true : false;
00282     }
00283 
00287     bool
00288     getDocumentOrder() const
00289     {
00290         return m_order == eDocumentOrder ? true : false;
00291     }
00292 
00298     void
00299     setDocumentOrder()
00300     {
00301         m_order = eDocumentOrder;
00302     }
00303 
00307     bool
00308     getReverseDocumentOrder() const
00309     {
00310         return m_order == eReverseDocumentOrder ? true : false;
00311     }
00312 
00318     void
00319     setReverseDocumentOrder()
00320     {
00321         m_order = eReverseDocumentOrder;
00322     }
00323 
00324     typedef NodeListVectorType::iterator    NodeListIteratorType;
00325 
00326     class addNodeInDocOrderFunctor
00327     {
00328     public:
00329 
00330         addNodeInDocOrderFunctor(
00331                 MutableNodeRefList&     theList,
00332                 XPathExecutionContext&  theExecutionContext) :
00333             m_list(theList),
00334             m_executionContext(theExecutionContext)
00335         {
00336         }
00337 
00338         void
00339         operator()(XalanNode*   theNode) const
00340         {
00341             m_list.addNodeInDocOrder(theNode, m_executionContext);
00342         }
00343 
00344     private:
00345 
00346         MutableNodeRefList&     m_list;
00347 
00348         XPathExecutionContext&  m_executionContext;
00349     };
00350 
00351 private:
00352 
00353     // An enum to determine what the order of the nodes is...
00354     enum eOrder { eUnknownOrder, eDocumentOrder, eReverseDocumentOrder };
00355 
00356     eOrder  m_order;
00357 };
00358 
00359 
00360 
00361 #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++ XSLT Processor Version 1.4
Copyright © 2000, 2001, 2002 The Apache Software Foundation. All Rights Reserved.