Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.5

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

NodeSorter.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(XALAN_NODESORTER_HEADER_GUARD)
00058 #define XALAN_NODESORTER_HEADER_GUARD
00059 
00067 // Base include file.  Must be first.
00068 #include "XSLTDefinitions.hpp"
00069 
00070 
00071 
00072 #include <functional>
00073 #include <vector>
00074 
00075 
00076 
00077 #include <XPath/XObject.hpp>
00078 
00079 
00080 
00081 #include <XSLT/NodeSortKey.hpp>
00082 
00083 
00084 
00085 XALAN_CPP_NAMESPACE_BEGIN
00086 
00087 
00088 
00089 class MutableNodeRefList;
00090 class StylesheetExecutionContext;
00091 class XalanNode;
00092 class XPath;
00093 
00094 
00095 
00099 class XALAN_XSLT_EXPORT NodeSorter
00100 {
00101 public:
00102 
00103     struct XALAN_XSLT_EXPORT VectorEntry
00104     {
00105     public:
00106 
00107         VectorEntry(
00108             XalanNode*      theNode = 0,
00109             unsigned int    thePosition = 0) :
00110             m_node(theNode),
00111             m_position(thePosition)
00112         {
00113         }
00114 
00115         XalanNode*      m_node;
00116         unsigned int    m_position;
00117     };
00118 
00119 #if defined(XALAN_NO_STD_NAMESPACE)
00120     typedef vector<VectorEntry>         NodeVectorType;
00121     typedef vector<NodeSortKey>         NodeSortKeyVectorType;
00122 #else
00123     typedef std::vector<VectorEntry>    NodeVectorType;
00124     typedef std::vector<NodeSortKey>    NodeSortKeyVectorType;
00125 #endif
00126 
00127     explicit
00128     NodeSorter();
00129   
00130     ~NodeSorter();
00131 
00132     NodeSortKeyVectorType&
00133     getSortKeys()
00134     {
00135         return m_keys;
00136     }
00137 
00145     void
00146     sort(
00147             StylesheetExecutionContext&     executionContext,
00148             MutableNodeRefList&             theList);
00149 
00153 #if defined(XALAN_NO_STD_NAMESPACE)
00154     struct XALAN_XSLT_EXPORT NodeSortKeyCompare : public binary_function<const NodeVectorType::value_type&, const NodeVectorType::value_type&, bool>
00155 #else
00156     struct XALAN_XSLT_EXPORT NodeSortKeyCompare : public std::binary_function<const NodeVectorType::value_type&, const NodeVectorType::value_type&, bool>
00157 #endif
00158     {
00159     public:
00160 
00168         NodeSortKeyCompare(
00169                 StylesheetExecutionContext&     executionContext,
00170                 NodeSorter&                     theSorter,
00171                 const NodeVectorType&           theNodes,
00172                 const NodeSortKeyVectorType&    theNodeSortKeys) :
00173             m_executionContext(executionContext),
00174             m_sorter(theSorter),
00175             m_nodes(theNodes),
00176             m_nodeSortKeys(theNodeSortKeys)
00177         {
00178         }
00179 
00189         int
00190         compare(
00191                 first_argument_type     theLHS,
00192                 second_argument_type    theRHS,
00193                 unsigned int            theKeyIndex = 0) const;
00194 
00203         result_type
00204         operator()(
00205                 first_argument_type     theLHS,
00206                 second_argument_type    theRHS,
00207                 unsigned int            theKeyIndex = 0) const
00208         {
00209             return compare(theLHS, theRHS, theKeyIndex) < 0 ? true : false;
00210         }
00211 
00212     protected:
00213 
00214         double
00215         getNumberResult(
00216                 const NodeSortKey&      theKey,
00217                 unsigned int            theKeyIndex,
00218                 first_argument_type     theEntry) const;
00219 
00220         const XObjectPtr&
00221         getStringResult(
00222                 const NodeSortKey&      theKey,
00223                 unsigned int            theKeyIndex,
00224                 first_argument_type     theEntry) const;
00225 
00226     private:
00227 
00228         StylesheetExecutionContext&     m_executionContext;
00229         NodeSorter&                     m_sorter;
00230         const NodeVectorType&           m_nodes;
00231         const NodeSortKeyVectorType&    m_nodeSortKeys;
00232     };
00233 
00234     friend struct NodeSortKeyCompare;
00235 
00236 #if defined(XALAN_NO_STD_NAMESPACE)
00237     typedef vector<double>      NumberResultsCacheVectorType;
00238 
00239     typedef vector<XObjectPtr>  StringResultsCacheVectorType;
00240 
00241     typedef vector<NumberResultsCacheVectorType>    NumberResultsCacheType;
00242     typedef vector<StringResultsCacheVectorType>    StringResultsCacheType;
00243 #else
00244     typedef std::vector<double>         NumberResultsCacheVectorType;
00245     typedef std::vector<XObjectPtr>     StringResultsCacheVectorType;
00246 
00247     typedef std::vector<NumberResultsCacheVectorType>   NumberResultsCacheType;
00248     typedef std::vector<StringResultsCacheVectorType>   StringResultsCacheType;
00249 #endif
00250 
00251 private:
00252 
00259     void
00260     sort(StylesheetExecutionContext&    executionContext);
00261 
00262     // Data members...
00263     NumberResultsCacheType  m_numberResultsCache;
00264 
00265     StringResultsCacheType  m_stringResultsCache;
00266 
00267     NodeSortKeyVectorType   m_keys;
00268 
00269     NodeVectorType          m_scratchVector;
00270 };
00271 
00272 
00273 
00274 XALAN_CPP_NAMESPACE_END
00275 
00276 
00277 
00278 #endif  // XALAN_NODESORTER_HEADER_GUARD

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.5
Copyright © 2000, 2001, 2002, 2003 The Apache Software Foundation. All Rights Reserved.