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  

NodeSorter.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(XALAN_NODESORTER_HEADER_GUARD)
00058 #define XALAN_NODESORTER_HEADER_GUARD
00059 
00064 
00065  
00066 
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 class MutableNodeRefList;
00086 class StylesheetExecutionContext;
00087 class XalanNode;
00088 class XPath;
00089 
00090 
00091 
00095 class XALAN_XSLT_EXPORT NodeSorter
00096 {
00097 public:
00098 
00099     struct XALAN_XSLT_EXPORT VectorEntry
00100     {
00101     public:
00102 
00103         VectorEntry(
00104             XalanNode*      theNode = 0,
00105             unsigned int    thePosition = 0) :
00106             m_node(theNode),
00107             m_position(thePosition)
00108         {
00109         }
00110 
00111         XalanNode*      m_node;
00112         unsigned int    m_position;
00113     };
00114 
00115 #if defined(XALAN_NO_NAMESPACES)
00116     typedef vector<VectorEntry>         NodeVectorType;
00117     typedef vector<NodeSortKey>         NodeSortKeyVectorType;
00118 #else
00119     typedef std::vector<VectorEntry>    NodeVectorType;
00120     typedef std::vector<NodeSortKey>    NodeSortKeyVectorType;
00121 #endif
00122 
00123     explicit
00124     NodeSorter();
00125   
00126     ~NodeSorter();
00127 
00128     NodeSortKeyVectorType&
00129     getSortKeys()
00130     {
00131         return m_keys;
00132     }
00133 
00141     void
00142     sort(
00143             StylesheetExecutionContext&     executionContext,
00144             MutableNodeRefList&             theList);
00145 
00149 #if defined(XALAN_NO_NAMESPACES)
00150     struct XALAN_XSLT_EXPORT NodeSortKeyCompare : public binary_function<const NodeVectorType::value_type&, const NodeVectorType::value_type&, bool>
00151 #else
00152     struct XALAN_XSLT_EXPORT NodeSortKeyCompare : public std::binary_function<const NodeVectorType::value_type&, const NodeVectorType::value_type&, bool>
00153 #endif
00154     {
00155     public:
00156 
00164         NodeSortKeyCompare(
00165                 StylesheetExecutionContext&     executionContext,
00166                 NodeSorter&                     theSorter,
00167                 const NodeVectorType&           theNodes,
00168                 const NodeSortKeyVectorType&    theNodeSortKeys) :
00169             m_executionContext(executionContext),
00170             m_sorter(theSorter),
00171             m_nodes(theNodes),
00172             m_nodeSortKeys(theNodeSortKeys)
00173         {
00174         }
00175 
00185         int
00186         compare(
00187                 first_argument_type     theLHS,
00188                 second_argument_type    theRHS,
00189                 unsigned int            theKeyIndex = 0) const;
00190 
00199         result_type
00200         operator()(
00201                 first_argument_type     theLHS,
00202                 second_argument_type    theRHS,
00203                 unsigned int            theKeyIndex = 0) const
00204         {
00205             return compare(theLHS, theRHS, theKeyIndex) < 0 ? true : false;
00206         }
00207 
00208     protected:
00209 
00210         double
00211         getNumberResult(
00212                 const NodeSortKey&      theKey,
00213                 unsigned int            theKeyIndex,
00214                 first_argument_type     theEntry) const;
00215 
00216         const XObjectPtr&
00217         getStringResult(
00218                 const NodeSortKey&      theKey,
00219                 unsigned int            theKeyIndex,
00220                 first_argument_type     theEntry) const;
00221 
00222     private:
00223 
00224         StylesheetExecutionContext&     m_executionContext;
00225         NodeSorter&                     m_sorter;
00226         const NodeVectorType&           m_nodes;
00227         const NodeSortKeyVectorType&    m_nodeSortKeys;
00228     };
00229 
00230     friend struct NodeSortKeyCompare;
00231 
00232 #if defined(XALAN_NO_NAMESPACES)
00233     typedef vector<double>      NumberResultsCacheVectorType;
00234 
00235     typedef vector<XObjectPtr>  StringResultsCacheVectorType;
00236 
00237     typedef vector<NumberResultsCacheVectorType>    NumberResultsCacheType;
00238     typedef vector<StringResultsCacheVectorType>    StringResultsCacheType;
00239 #else
00240     typedef std::vector<double>         NumberResultsCacheVectorType;
00241     typedef std::vector<XObjectPtr>     StringResultsCacheVectorType;
00242 
00243     typedef std::vector<NumberResultsCacheVectorType>   NumberResultsCacheType;
00244     typedef std::vector<StringResultsCacheVectorType>   StringResultsCacheType;
00245 #endif
00246 
00247 private:
00248 
00255     void
00256     sort(StylesheetExecutionContext&    executionContext);
00257 
00258     // Data members...
00259     NumberResultsCacheType  m_numberResultsCache;
00260 
00261     StringResultsCacheType  m_stringResultsCache;
00262 
00263     NodeSortKeyVectorType   m_keys;
00264 
00265     NodeVectorType          m_scratchVector;
00266 };
00267 
00268 
00269 
00270 #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.4
Copyright © 2000, 2001, 2002 The Apache Software Foundation. All Rights Reserved.